diff --git a/.gitignore b/.gitignore index 0d20b64..c9b568f 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,2 @@ *.pyc +*.swp diff --git a/.travis.yml b/.travis.yml index 3a9cb61..406e470 100644 --- a/.travis.yml +++ b/.travis.yml @@ -12,9 +12,9 @@ before_install: # command to install dependencies install: - - if [[ $TRAVIS_PYTHON_VERSION == '2.7' ]]; then pip install lxml contextlib2 mock; fi - - if [[ $TRAVIS_PYTHON_VERSION == '3.3' ]]; then pip install lxml numpy; fi - - if [[ $TRAVIS_PYTHON_VERSION == '3.4' ]]; then pip install lxml numpy; fi + - if [[ $TRAVIS_PYTHON_VERSION == '2.7' ]]; then pip install lxml contextlib2 mock six; fi + - if [[ $TRAVIS_PYTHON_VERSION == '3.3' ]]; then pip install lxml numpy six; fi + - if [[ $TRAVIS_PYTHON_VERSION == '3.4' ]]; then pip install lxml numpy six; fi # command to run tests script: diff --git a/CHANGES.txt b/CHANGES.txt index 44d6832..042e351 100644 --- a/CHANGES.txt +++ b/CHANGES.txt @@ -1,4 +1,15 @@ -Mar 06, 2014 - Added Cinema2K, Cinema4K write support. +Jan 10, 2015 - v0.8.0 Reduced number of steps required for writing + images. Deprecated old read and write methods in favor of + array-style slicing. Added ignore_pclr_cmap_cdef, verbose, + shape, codestream, layer properties. + +Oct 06, 2014 - v0.7.2 Added ellipsis support in array-style slicing. + +Oct 02, 2014 - v0.7.1 Fixed README to mention Python 3.4 + +Oct 01, 2014 - v0.7.0 Added array-style slicing. + +August 03, 2014 - v0.6.0 Added Cinema2K, Cinema4K write support. Changed constructor for ChannelDefinition box. Removed support for Python 2.6. Added write support for JP2 UUID, DataEntryURL, Palette and Component Mapping boxes, JPX Association, NumberList diff --git a/README.md b/README.md index 22338f1..bdc84d4 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,6 @@ glymur: a Python interface for JPEG 2000 **glymur** contains a Python interface to the OpenJPEG library which allows one to read and write JPEG 2000 files. **glymur** works on -Python 2.7 and 3.3. Python 3.3 is strongly recommended. +Python 2.7, 3.3, and 3.4. Please read the docs, https://glymur.readthedocs.org/en/latest/ diff --git a/bin/jp2dump b/bin/jp2dump deleted file mode 100755 index 7632aff..0000000 --- a/bin/jp2dump +++ /dev/null @@ -1,34 +0,0 @@ -#!/usr/bin/env python - -import argparse -import sys -import glymur - -description='Print JPEG2000 metadata.' -parser = argparse.ArgumentParser(description=description) -parser.add_argument('-x', '--noxml', help='Suppress XML.', - action='store_true') -parser.add_argument('-s', '--short', help='Only print box id, offset, and length.', - action='store_true') -chelp='Level of codestream information. 0 suppressed all details, 1 prints headers, 2 prints the full codestream' -parser.add_argument('-c', '--codestream', - help=chelp, - nargs=1, - type=int, - default=[0]) -parser.add_argument('filename') -args = parser.parse_args() -if args.noxml: - glymur.set_printoptions(xml=False) -if args.short: - glymur.set_printoptions(short=True) -if args.codestream[0] == 0: - glymur.set_printoptions(codestream=False) - print_full_codestream = False -elif args.codestream[0] == 1: - print_full_codestream = False -else: - print_full_codestream = True - -filename = args.filename -glymur.jp2dump(args.filename, codestream=print_full_codestream) diff --git a/docs/source/api.rst b/docs/source/api.rst deleted file mode 100644 index 7584718..0000000 --- a/docs/source/api.rst +++ /dev/null @@ -1,116 +0,0 @@ ---- -API ---- - -Jp2k ----- -.. autoclass:: glymur.Jp2k - :members: read, write, wrap, read_bands, get_codestream - -Individual Boxes ----------------- -Jp2kbox -''''''' -.. autoclass:: glymur.jp2box.Jp2kBox - :members: - -AssociationBox -'''''''''''''' -.. autoclass:: glymur.jp2box.AssociationBox - :members: - -ColourSpecificationBox -'''''''''''''''''''''' -.. autoclass:: glymur.jp2box.ColourSpecificationBox - :members: - -ChannelDefinitionBox -'''''''''''''''''''''' -.. autoclass:: glymur.jp2box.ChannelDefinitionBox - :members: - -ComponentMappingBox -''''''''''''''''''' -.. autoclass:: glymur.jp2box.ComponentMappingBox - :members: - -ContiguousCodestreamBox -''''''''''''''''''''''' -.. autoclass:: glymur.jp2box.ContiguousCodestreamBox - :members: - -DataEntryURLBox -''''''''''''''' -.. autoclass:: glymur.jp2box.DataEntryURLBox - :members: - -FileTypeBox -''''''''''' -.. autoclass:: glymur.jp2box.FileTypeBox - :members: - -ImageHeaderBox -'''''''''''''' -.. autoclass:: glymur.jp2box.ImageHeaderBox - :members: - -JP2HeaderBox -'''''''''''' -.. autoclass:: glymur.jp2box.JP2HeaderBox - :members: - -JPEG2000SignatureBox -'''''''''''''''''''' -.. autoclass:: glymur.jp2box.JPEG2000SignatureBox - :members: - -LabelBox -'''''''' -.. autoclass:: glymur.jp2box.LabelBox - :members: - -PaletteBox -'''''''''' -.. autoclass:: glymur.jp2box.PaletteBox - :members: - -ReaderRequirementsBox -''''''''''''''''''''' -.. autoclass:: glymur.jp2box.ReaderRequirementsBox - :members: - -ResolutionBox -''''''''''''' -.. autoclass:: glymur.jp2box.ResolutionBox - :members: - -CaptureResolutionBox -'''''''''''''''''''' -.. autoclass:: glymur.jp2box.CaptureResolutionBox - :members: - -DisplayResolutionBox -'''''''''''''''''''' -.. autoclass:: glymur.jp2box.DisplayResolutionBox - :members: - -UUIDBox -''''''' -.. autoclass:: glymur.jp2box.UUIDBox - :members: - -UUIDInfoBox -''''''''''' -.. autoclass:: glymur.jp2box.UUIDInfoBox - :members: - -UUIDListBox -''''''''''' -.. autoclass:: glymur.jp2box.UUIDListBox - :members: - -XMLBox -'''''' -.. autoclass:: glymur.jp2box.XMLBox - :members: - diff --git a/docs/source/conf.py b/docs/source/conf.py index 3e6b26e..76f96f6 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -13,7 +13,6 @@ # serve to show the default. import sys -import os class Mock(object): @@ -42,12 +41,12 @@ for mod_name in MOCK_MODULES: # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. -#sys.path.insert(0, os.path.abspath('.')) +# sys.path.insert(0, os.path.abspath('.')) # -- General configuration ---------------------------------------------------- # If your documentation needs a minimal Sphinx version, state it here. -#needs_sphinx = '1.0' +# needs_sphinx = '1.0' # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones. @@ -62,7 +61,7 @@ templates_path = ['_templates'] source_suffix = '.rst' # The encoding of source files. -#source_encoding = 'utf-8-sig' +# source_encoding = 'utf-8-sig' # The master toctree document. master_doc = 'index' @@ -76,19 +75,19 @@ copyright = u'2013, John Evans' # built documents. # # The short X.Y version. -version = '0.6' +version = '0.8' # The full version, including alpha/beta/rc tags. -release = '0.6.0' +release = '0.8.0' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. -#language = None +# language = None # There are two options for replacing |today|: either, you set today to some # non-false value, then it is used: -#today = '' +# today = '' # Else, today_fmt is used as the format for a strftime call. -#today_fmt = '%B %d, %Y' +# today_fmt = '%B %d, %Y' # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. @@ -96,24 +95,24 @@ exclude_patterns = [] # The reST default role (used for this markup: `text`) to use for all # documents. -#default_role = None +# default_role = None # If true, '()' will be appended to :func: etc. cross-reference text. -#add_function_parentheses = True +# add_function_parentheses = True # If true, the current module name will be prepended to all description # unit titles (such as .. function::). -#add_module_names = True +# add_module_names = True # If true, sectionauthor and moduleauthor directives will be shown in the # output. They are ignored by default. -#show_authors = False +# show_authors = False # The name of the Pygments (syntax highlighting) style to use. pygments_style = 'sphinx' # A list of ignored prefixes for module index sorting. -#modindex_common_prefix = [] +# modindex_common_prefix = [] # -- Options for HTML output -------------------------------------------------- @@ -125,26 +124,26 @@ html_theme = 'default' # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the # documentation. -#html_theme_options = {} +# html_theme_options = {} # Add any paths that contain custom themes here, relative to this directory. -#html_theme_path = [] +# html_theme_path = [] # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". -#html_title = None +# html_title = None # A shorter title for the navigation bar. Default is the same as html_title. -#html_short_title = None +# html_short_title = None # The name of an image file (relative to this directory) to place at the top # of the sidebar. -#html_logo = None +# html_logo = None # The name of an image file (within the static path) to use as favicon of the # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 # pixels large. -#html_favicon = None +# html_favicon = None # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, @@ -153,44 +152,44 @@ html_static_path = ['_static'] # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, # using the given strftime format. -#html_last_updated_fmt = '%b %d, %Y' +# html_last_updated_fmt = '%b %d, %Y' # If true, SmartyPants will be used to convert quotes and dashes to # typographically correct entities. -#html_use_smartypants = True +# html_use_smartypants = True # Custom sidebar templates, maps document names to template names. -#html_sidebars = {} +# html_sidebars = {} # Additional templates that should be rendered to pages, maps page names to # template names. -#html_additional_pages = {} +# html_additional_pages = {} # If false, no module index is generated. -#html_domain_indices = True +# html_domain_indices = True # If false, no index is generated. -#html_use_index = True +# html_use_index = True # If true, the index is split into individual pages for each letter. -#html_split_index = False +# html_split_index = False # If true, links to the reST sources are added to the pages. html_show_sourcelink = True # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. -#html_show_sphinx = True +# html_show_sphinx = True # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. -#html_show_copyright = True +# html_show_copyright = True # If true, an OpenSearch description file will be output, and all pages will # contain a tag referring to it. The value of this option must be the # base URL from which the finished HTML is served. -#html_use_opensearch = '' +# html_use_opensearch = '' # This is the file name suffix for HTML files (e.g. ".xhtml"). -#html_file_suffix = None +# html_file_suffix = None # Output file base name for HTML help builder. htmlhelp_basename = 'glymurdoc' @@ -199,13 +198,13 @@ htmlhelp_basename = 'glymurdoc' # -- Options for LaTeX output ------------------------------------------------- # The paper size ('letterpaper' or 'a4paper'). -#'papersize': 'letterpaper', +# 'papersize': 'letterpaper', # The font size ('10pt', '11pt' or '12pt'). -#'pointsize': '10pt', +# 'pointsize': '10pt', # Additional stuff for the LaTeX preamble. -#'preamble': '', +# 'preamble': '', latex_elements = {} # Grouping the document tree into LaTeX files. List of tuples @@ -216,23 +215,23 @@ latex_documents = [('index', 'glymur.tex', u'glymur Documentation', # The name of an image file (relative to this directory) to place at the top of # the title page. -#latex_logo = None +# latex_logo = None # For "manual" documents, if this is true, then toplevel headings are parts, # not chapters. -#latex_use_parts = False +# latex_use_parts = False # If true, show page references after internal links. -#latex_show_pagerefs = False +# latex_show_pagerefs = False # If true, show URL addresses after external links. -#latex_show_urls = False +# latex_show_urls = False # Documents to append as an appendix to all manuals. -#latex_appendices = [] +# latex_appendices = [] # If false, no module index is generated. -#latex_domain_indices = True +# latex_domain_indices = True # -- Options for manual page output ------------------------------------------- @@ -245,7 +244,7 @@ man_pages = [ ] # If true, show URL addresses after external links. -#man_show_urls = False +# man_show_urls = False # -- Options for Texinfo output ----------------------------------------------- @@ -258,13 +257,13 @@ texinfo_documents = [('index', 'glymur', u'glymur Documentation', 'One line description of project.', 'Miscellaneous'), ] # Documents to append as an appendix to all manuals. -#texinfo_appendices = [] +# texinfo_appendices = [] # If false, no module index is generated. -#texinfo_domain_indices = True +# texinfo_domain_indices = True # How to display URL addresses: 'footnote', 'no', or 'inline'. -#texinfo_show_urls = 'footnote' +# texinfo_show_urls = 'footnote' # Example configuration for intersphinx: refer to the Python standard library. diff --git a/docs/source/detailed_installation.rst b/docs/source/detailed_installation.rst index ecf0632..7068b56 100644 --- a/docs/source/detailed_installation.rst +++ b/docs/source/detailed_installation.rst @@ -15,7 +15,7 @@ or if you use windows, then read on. Glymur uses ctypes to access the openjp2/openjpeg libraries, and because ctypes accesses libraries in a platform-dependent manner, -it is recommended that if you compile and install OpenJPEG into a +it is recommended that **if** you compile and install OpenJPEG into a non-standard location, you should then create a configuration file to help Glymur properly find the openjpeg or openjp2 libraries (linux users or macports users don’t need to bother with this if @@ -24,11 +24,11 @@ configuration format is the same as used by Python’s configparser module, i.e. :: [library] - openjp2: /opt/openjp2-svn/lib/libopenjp2.so + openjp2: /somewhere/lib/libopenjp2.so This assumes, of course, that you've installed OpenJPEG into -/opt/openjp2-svn on a linux system. The location of the configuration file -can vary as well (of course). If you use either linux or mac, the path +/opt/openjpeg on a linux system. The location of the configuration file +can vary as well. If you use either linux or mac, the path to the configuration file would normally be :: $HOME/.config/glymur/glymurrc @@ -48,7 +48,10 @@ You may also include a line for the version 1.x openjpeg library if you have it installed in a non-standard place, i.e. :: [library] - openjpeg: /not/the/usual/location/lib/libopenjpeg.so + openjpeg: /somewhere/lib/libopenjpeg.so + +Once again, you should not have to bother with a configuration file if you use +mac or linux and OpenJPEG is provided by your package manager. ''''''' Testing diff --git a/docs/source/how_do_i.rst b/docs/source/how_do_i.rst index ebe7a31..88d94fa 100644 --- a/docs/source/how_do_i.rst +++ b/docs/source/how_do_i.rst @@ -3,29 +3,46 @@ How do I...? ------------ -... read the lowest resolution thumbnail? -========================================= -Printing the Jp2k object should reveal the number of resolutions -(look in the COD segment section of the codestream), but you can -take a shortcut by supplying -1 as the -resolution level. :: +... read images? +================ +Jp2k implements slicing via the :py:meth:`__getitem__` method, meaning that +multiple resolution imagery in a JPEG 2000 file can +easily be accessed via array-style slicing. For example here's how to +retrieve a full resolution and first lower-resolution image :: >>> import glymur - >>> jp2file = glymur.data.nemo() + >>> jp2file = glymur.data.nemo() # just a path to a JPEG2000 file >>> jp2 = glymur.Jp2k(jp2file) - >>> thumbnail = jp2.read(rlevel=-1) + >>> fullres = jp2[:] + >>> fullres.shape + (1456, 2592, 3) + >>> thumbnail = jp2[::2, ::2] + >>> thumbnail.shape + (728, 1296, 3) + +... write images? +================= +It's pretty simple, just supply the image data as the 2nd argument to the Jp2k +constructor. + + >>> import glymur, numpy as np + >>> jp2 = glymur.Jp2k('zeros.jp2', data=np.zeros((640, 480), dtype=np.uint8) + +You must have OpenJPEG version 1.5 or more recent in order to write JPEG 2000 +images with glymur. ... display metadata? ===================== -There are two ways. From the unix command line, the script **jp2dump** is +There are two ways. From the command line, the console script **jp2dump** is available. :: $ jp2dump /path/to/glymur/installation/data/nemo.jp2 -From within Python, it is as simple as printing the Jp2k object, i.e. :: +From within Python, the same result is obtained simply by printing the Jp2k +object, i.e. :: >>> import glymur - >>> jp2file = glymur.data.nemo() + >>> jp2file = glymur.data.nemo() # just a path to a JP2 file >>> jp2 = glymur.Jp2k(jp2file) >>> print(jp2) File: nemo.jp2 @@ -197,9 +214,9 @@ making use of the :py:meth:`set_printoptions` function:: UUID: be7acfcb-97a9-42e8-9c71-999491e3afac (XMP) Contiguous Codestream Box (jp2c) @ (3223, 1132296) -It is possible to print all the gory codestream details as well, i.e. :: +It is possible to easily print the codestream header details as well, i.e. :: - >>> print(j.get_codestream()) # details not shown + >>> print(j.codestream) # details not show ... add XML metadata? ===================== @@ -319,10 +336,10 @@ is currently limited to XML and UUID boxes. ... create an image with an alpha layer? ======================================== -OpenJPEG can create JP2 files with more than 3 components (requires -the development version of OpenJPEG), but by default, any extra components are -not described as such. In order to do so, we need to rewrap such -an image in a set of boxes that includes a channel definition box. +OpenJPEG can create JP2 files with more than 3 components (use version 2.1.0+ +for this), but by default, any extra components are not described +as such. In order to do so, we need to rewrap such an image in a +set of boxes that includes a channel definition box. This example is based on SciPy example code found at http://scipy-lectures.github.io/advanced/image_processing/#basic-manipulations . @@ -332,15 +349,14 @@ image isn't square. :: >>> import numpy as np >>> import glymur >>> from glymur import Jp2k - >>> rgb = Jp2k(glymur.data.goodstuff()).read() + >>> rgb = Jp2k(glymur.data.goodstuff())[:] >>> lx, ly = rgb.shape[0:2] >>> X, Y = np.ogrid[0:lx, 0:ly] >>> mask = ly**2*(X - lx / 2) ** 2 + lx**2*(Y - ly / 2) ** 2 > (lx * ly / 2)**2 >>> alpha = 255 * np.ones((lx, ly, 1), dtype=np.uint8) >>> alpha[mask] = 0 >>> rgba = np.concatenate((rgb, alpha), axis=2) - >>> jp2 = Jp2k('tmp.jp2', 'wb') - >>> jp2.write(rgba) + >>> jp2 = Jp2k('tmp.jp2', data=rgba) Next we need to specify what types of channels we have. The first three channels are color channels, but we identify the fourth as @@ -380,7 +396,11 @@ Here's how the Preview application on the mac shows the RGBA image. ... work with XMP UUIDs? ======================== -XMP is metadata on steroids. +`Wikipedia `_ states +that "The Extensible Metadata Platform (XMP) is an ISO standard, +originally created by Adobe Systems Inc., for the creation, processing +and interchange of standardized and custom metadata for all kinds +of resources." The example JP2 file shipped with glymur has an XMP UUID. :: @@ -422,7 +442,7 @@ following 'Google' But that would be painful. A better solution is to install the Python XMP -Toolkit (make sure it is version 2.0):: +Toolkit (make sure it is at least version 2.0):: >>> from libxmp import XMPMeta >>> from libxmp.consts import XMP_NS_XMP as NS_XAP @@ -439,8 +459,7 @@ http://photojournal.jpl.nasa.gov/tiff/PIA17145.tif info JPEG 2000:: >>> import skimage.io >>> image = skimage.io.imread('PIA17145.tif') >>> from glymur import Jp2k - >>> jp2 = Jp2k('PIA17145.jp2', 'wb') - >>> jp2.write(image) + >>> jp2 = Jp2k('PIA17145.jp2', data=image) Next you can extract the XMP metadata. diff --git a/docs/source/index.rst b/docs/source/index.rst index 0675eef..62e118d 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -15,7 +15,6 @@ Contents: introduction detailed_installation how_do_i - api whatsnew/index roadmap diff --git a/docs/source/introduction.rst b/docs/source/introduction.rst index 3ae697e..ae6d6ab 100644 --- a/docs/source/introduction.rst +++ b/docs/source/introduction.rst @@ -5,13 +5,16 @@ Glymur: a Python interface for JPEG 2000 **Glymur** is an interface to the OpenJPEG library which allows one to read and write JPEG 2000 files from Python. Glymur supports both reading and writing of JPEG 2000 images, but writing -JPEG 2000 images is currently limited to images that can fit in memory +JPEG 2000 images is currently limited to images that can fit in memory. +**Glymur** can read images using OpenJPEG library versions as far back as 1.3, +but it is strongly recommended to use version 2.1.0, which is the most recently +released version of OpenJPEG at this time. In regards to metadata, most JP2 boxes are properly interpreted. Certain optional JP2 boxes can also be written, including XML boxes and XMP UUIDs. There is incomplete support for reading JPX metadata. -Glymur 0.6 works on Python versions 2.7, 3.3 and 3.4. If you have Python 2.6, +Glymur works on Python versions 2.7, 3.3 and 3.4. If you have Python 2.6, you should use the 0.5 series of Glymur. For more information about OpenJPEG, please consult http://www.openjpeg.org. @@ -27,10 +30,6 @@ but you should also be able to install Glymur via pip :: $ pip install glymur -This will install a script **jp2dump** that can be used from the unix command -line for dumping JP2 metadata, so you should adjust your **$PATH** -environment variable to take advantage of it. For example, if you install -with pip's `--user` option on linux :: - - $ export PATH=$HOME/.local/bin:$PATH - +In addition to the package, this also gives you a command line script +**jp2dump** that can be used from the command line line to print JPEG 2000 +metadata. diff --git a/docs/source/whatsnew/0.7.rst b/docs/source/whatsnew/0.7.rst new file mode 100644 index 0000000..3ed7715 --- /dev/null +++ b/docs/source/whatsnew/0.7.rst @@ -0,0 +1,27 @@ +===================== +Changes in glymur 0.7 +===================== + +Changes in 0.7.3 +================= + + * added read support back for metadata only when the OpenJPEG library is + not installed + +Changes in 0.7.2 +================= + + * added ellipsis support in array-style slicing + +Changes in 0.7.1 +================= + + * fixed release notes regarding Python 3.4 + +Changes in 0.7.0 +================= + + * implemented :py:meth:`__getitem__`, :py:meth:`__setitem__` support + * added back windows support + * box_id and longname are class attributes now instead of instance + attributes diff --git a/docs/source/whatsnew/0.8.rst b/docs/source/whatsnew/0.8.rst new file mode 100644 index 0000000..e7215ad --- /dev/null +++ b/docs/source/whatsnew/0.8.rst @@ -0,0 +1,24 @@ +===================== +Changes in glymur 0.8 +===================== + +Changes in 0.8.0 +================= + + * Simplified writing images by moving data and options into the + constructor. + * Deprecated :py:meth:`read` method in favor of array-style slicing. + In order to retain certain functionality, the following parameters + to the :py:meth:`read` method have become top-level properties + + * verbose + * layer + * ignore_pclr_cmap_cdef + + * Two additional properties were introduced. + + * codestream + * shape + + + diff --git a/docs/source/whatsnew/index.rst b/docs/source/whatsnew/index.rst index da7e319..4569abd 100644 --- a/docs/source/whatsnew/index.rst +++ b/docs/source/whatsnew/index.rst @@ -8,5 +8,7 @@ These document the changes between minor (or major) versions of glymur. .. toctree:: - 0.5 + 0.8 + 0.7 0.6 + 0.5 diff --git a/glymur/__init__.py b/glymur/__init__.py index f39d6ef..d8971b2 100644 --- a/glymur/__init__.py +++ b/glymur/__init__.py @@ -1,20 +1,25 @@ """glymur - read, write, and interrogate JPEG 2000 files """ -import sys import unittest from glymur import version __version__ = version.version from .jp2k import Jp2k -from .jp2dump import jp2dump -from .jp2box import get_printoptions, set_printoptions -from .jp2box import get_parseoptions, set_parseoptions +from .jp2box import (get_printoptions, + set_printoptions, + get_parseoptions, + set_parseoptions) from . import data + def runtests(): """Discover and run all tests for the glymur package. """ suite = unittest.defaultTestLoader.discover(__path__[0]) unittest.TextTestRunner(verbosity=2).run(suite) + + +__all__ = [__version__, Jp2k, get_printoptions, set_printoptions, + get_parseoptions, set_parseoptions, data, runtests] diff --git a/glymur/_uuid_io.py b/glymur/_uuid_io.py index bf9960a..3c63b0a 100644 --- a/glymur/_uuid_io.py +++ b/glymur/_uuid_io.py @@ -3,14 +3,13 @@ Part of glymur. """ from collections import OrderedDict -import pprint -import re import struct import sys import warnings import lxml.etree as ET + def xml(raw_data): """ XMP data to be parsed as XML. @@ -23,6 +22,7 @@ def xml(raw_data): return ET.ElementTree(elt) + def tiff_header(read_buffer): """ Interpret the uuid raw data as a tiff header. @@ -37,8 +37,8 @@ def tiff_header(read_buffer): # big endian endian = '>' else: - msg = "The byte order indication in the TIFF header ({0}) is invalid. " - msg += "It should be either {1} or {2}." + msg = "The byte order indication in the TIFF header ({0}) is " + msg += "invalid. It should be either {1} or {2}." msg = msg.format(read_buffer[6:8], bytes([73, 73]), bytes([77, 77])) raise IOError(msg) @@ -503,6 +503,3 @@ class _ExifInteroperabilityIfd(_Ifd): def __init__(self, endian, read_buffer, offset): _Ifd.__init__(self, endian, read_buffer, offset) self.post_process(self.tagnum2name) - - - diff --git a/glymur/codestream.py b/glymur/codestream.py index acc7791..ea94afd 100644 --- a/glymur/codestream.py +++ b/glymur/codestream.py @@ -6,16 +6,13 @@ codestreams. # The number of lines in the module is long and that's ok. It would not help # matters to move anything out to another file. -# pylint: disable=C0302 # "Too many instance attributes", "Too many arguments" # Some segments just have a lot of information. # It doesn't make sense to subclass just for that. -# pylint: disable=R0902,R0913 # "Too few public methods" Some segments don't define any new methods from # the base Segment class. -# pylint: disable=R0903 import math import struct @@ -24,23 +21,22 @@ import warnings import numpy as np -from .core import LRCP, RLCP, RPCL, PCRL, CPRL -from .core import WAVELET_XFORM_9X7_IRREVERSIBLE -from .core import WAVELET_XFORM_5X3_REVERSIBLE -from .core import _Keydefaultdict +from .core import (LRCP, RLCP, RPCL, PCRL, CPRL, + WAVELET_XFORM_9X7_IRREVERSIBLE, + WAVELET_XFORM_5X3_REVERSIBLE, + _Keydefaultdict) from .lib import openjp2 as opj2 _factory = lambda x: '{0} (invalid)'.format(x) -_PROGRESSION_ORDER_DISPLAY = _Keydefaultdict(_factory, - { LRCP: 'LRCP', - RLCP: 'RLCP', - RPCL: 'RPCL', - PCRL: 'PCRL', - CPRL: 'CPRL'}) +_PROGRESSION_ORDER_DISPLAY = _Keydefaultdict(_factory, {LRCP: 'LRCP', + RLCP: 'RLCP', + RPCL: 'RPCL', + PCRL: 'PCRL', + CPRL: 'CPRL'}) -_WAVELET_TRANSFORM_DISPLAY = _Keydefaultdict(_factory, - { WAVELET_XFORM_9X7_IRREVERSIBLE: '9-7 irreversible', - WAVELET_XFORM_5X3_REVERSIBLE: '5-3 reversible'}) +_keysvalues = {WAVELET_XFORM_9X7_IRREVERSIBLE: '9-7 irreversible', + WAVELET_XFORM_5X3_REVERSIBLE: '5-3 reversible'} +_WAVELET_TRANSFORM_DISPLAY = _Keydefaultdict(_factory, _keysvalues) _NO_PROFILE = 0 _PROFILE_0 = 1 @@ -51,12 +47,11 @@ _PROFILE_4 = 4 _KNOWN_PROFILES = [_NO_PROFILE, _PROFILE_0, _PROFILE_1, _PROFILE_3, _PROFILE_4] # How to display the codestream profile. -_CAPABILITIES_DISPLAY = _Keydefaultdict(_factory, - { _NO_PROFILE: 'no profile', - _PROFILE_0: '0', - _PROFILE_1: '1', - _PROFILE_3: 'Cinema 2K', - _PROFILE_4: 'Cinema 4K'} ) +_CAPABILITIES_DISPLAY = _Keydefaultdict(_factory, {_NO_PROFILE: 'no profile', + _PROFILE_0: '0', + _PROFILE_1: '1', + _PROFILE_3: 'Cinema 2K', + _PROFILE_4: 'Cinema 4K'}) # Need a catch-all list of valid markers. # See table A-1 in ISO/IEC FCD15444-1. @@ -202,7 +197,7 @@ class Codestream(object): msg = 'Invalid marker id encountered at byte {0:d} ' msg += 'in codestream: "0x{1:x}"' msg = msg.format(self._offset, self._marker_id) - warnings.warn(msg) + warnings.warn(msg, UserWarning) break self.segment.append(segment) @@ -298,7 +293,6 @@ class Codestream(object): msg += ''.join(strs) return msg - # pylint: disable=R0201 def _parse_cme_segment(self, fptr): """Parse the CME marker segment. @@ -642,7 +636,7 @@ class Codestream(object): srgn = data[1] sprgn = data[2] - return RGNsegment(length, offset, crgn, srgn, sprgn) + return RGNsegment(crgn, srgn, sprgn, length, offset) def _parse_siz_segment(self, fptr): """Parse the SIZ segment. @@ -694,7 +688,7 @@ class Codestream(object): try: num_tiles_x = (xysiz[0] - xyosiz[0]) / (xytsiz[0] - xytosiz[0]) num_tiles_y = (xysiz[1] - xyosiz[1]) / (xytsiz[1] - xytosiz[1]) - except ZeroDivisionError as err: + except ZeroDivisionError: warnings.warn("Invalid tile dimensions.") else: numtiles = math.ceil(num_tiles_x) * math.ceil(num_tiles_y) @@ -702,7 +696,6 @@ class Codestream(object): msg = "Invalid number of tiles ({0}).".format(numtiles) warnings.warn(msg) - kwargs = {'rsiz': rsiz, 'xysiz': xysiz, 'xyosiz': xyosiz, @@ -829,7 +822,6 @@ class Codestream(object): return TLMsegment(length, offset, ztlm, ttlm, ptlm) - # pylint: disable=W0613 def _parse_reserved_marker(self, fptr): """Marker range between 0xff30 and 0xff39. """ @@ -1074,7 +1066,7 @@ class CMEsegment(Segment): 15444-1:2004 - Information technology -- JPEG 2000 image coding system: Core coding system """ - def __init__(self, rcme, ccme, length, offset): + def __init__(self, rcme, ccme, length=-1, offset=-1): Segment.__init__(self, marker_id='CME') self.rcme = rcme self.ccme = ccme @@ -1463,7 +1455,7 @@ class RGNsegment(Segment): 15444-1:2004 - Information technology -- JPEG 2000 image coding system: Core coding system """ - def __init__(self, length, offset, crgn, srgn, sprgn): + def __init__(self, crgn, srgn, sprgn, length=-1, offset=-1): Segment.__init__(self, marker_id='RGN') self.length = length self.offset = offset @@ -1613,6 +1605,7 @@ class SOCsegment(Segment): msg = "glymur.codestream.SOCsegment()" return msg + class SODsegment(Segment): """Container for Start of Data (SOD) segment information. @@ -1726,7 +1719,7 @@ class SOTsegment(Segment): 15444-1:2004 - Information technology -- JPEG 2000 image coding system: Core coding system """ - def __init__(self, isot, psot, tpsot, tnsot, length, offset): + def __init__(self, isot, psot, tpsot, tnsot, length=-1, offset=-1): Segment.__init__(self, marker_id='SOT') self.isot = isot self.psot = psot diff --git a/glymur/command_line.py b/glymur/command_line.py new file mode 100644 index 0000000..3d1d57e --- /dev/null +++ b/glymur/command_line.py @@ -0,0 +1,78 @@ +""" +Entry point for console script jp2dump. +""" +import argparse +import os +import warnings + +from . import Jp2k, set_printoptions, set_parseoptions, lib + + +def main(): + """ + Entry point for console script jp2dump. + """ + + kwargs = {'description': 'Print JPEG2000 metadata.', + 'formatter_class': argparse.ArgumentDefaultsHelpFormatter} + parser = argparse.ArgumentParser(**kwargs) + + parser.add_argument('-x', '--noxml', + help='suppress XML', + action='store_true') + parser.add_argument('-s', '--short', + help='only print box id, offset, and length', + action='store_true') + + chelp = 'Level of codestream information. 0 suppresses all details, ' + chelp += '1 prints the main header, 2 prints the full codestream.' + parser.add_argument('-c', '--codestream', + help=chelp, + metavar='LEVEL', + nargs=1, + type=int, + default=[1]) + + parser.add_argument('filename') + + args = parser.parse_args() + if args.noxml: + set_printoptions(xml=False) + if args.short: + set_printoptions(short=True) + + codestream_level = args.codestream[0] + if codestream_level not in [0, 1, 2]: + raise ValueError("Invalid level of codestream information specified.") + + if codestream_level == 0: + set_printoptions(codestream=False) + elif codestream_level == 2: + set_parseoptions(full_codestream=True) + + filename = args.filename + + with warnings.catch_warnings(record=True) as wctx: + + # JP2 metadata can be extensive, so don't print any warnings until we + # are done with the metadata. + jp2 = Jp2k(filename) + if jp2._codec_format == lib.openjp2.CODEC_J2K: + if codestream_level == 0: + print('File: {0}'.format(os.path.basename(filename))) + elif codestream_level == 1: + print(jp2) + elif codestream_level == 2: + print('File: {0}'.format(os.path.basename(filename))) + print(jp2.get_codestream(header_only=False)) + else: + print(jp2) + + # Re-emit any warnings that may have been suppressed. + if len(wctx) > 0: + print("\n") + for warning in wctx: + print("{0}:{1}: {2}: {3}".format(warning.filename, + warning.lineno, + warning.category.__name__, + warning.message)) diff --git a/glymur/core.py b/glymur/core.py index 4d9a3af..644dcfd 100644 --- a/glymur/core.py +++ b/glymur/core.py @@ -1,8 +1,7 @@ """Core definitions to be shared amongst the modules. """ import collections -import copy -import lxml.etree as ET + class _Keydefaultdict(collections.defaultdict): """Unlisted keys help form their own error message. @@ -121,12 +120,12 @@ ROMM_RGB = 21 _factory = lambda x: '{0} (unrecognized)'.format(x) _COLORSPACE_MAP_DISPLAY = _Keydefaultdict(_factory, - { CMYK: 'CMYK', - SRGB: 'sRGB', - GREYSCALE: 'greyscale', - YCC: 'YCC', - E_SRGB: 'e-sRGB', - ROMM_RGB: 'ROMM-RGB'} ) + {CMYK: 'CMYK', + SRGB: 'sRGB', + GREYSCALE: 'greyscale', + YCC: 'YCC', + E_SRGB: 'e-sRGB', + ROMM_RGB: 'ROMM-RGB'}) # enumerated color channel types COLOR = 0 @@ -134,11 +133,11 @@ OPACITY = 1 PRE_MULTIPLIED_OPACITY = 2 _UNSPECIFIED = 65535 _factory = lambda x: '{0} (invalid)'.format(x) -_COLOR_TYPE_MAP_DISPLAY = _Keydefaultdict(_factory, - { COLOR: 'color', - OPACITY: 'opacity', - PRE_MULTIPLIED_OPACITY: 'pre-multiplied opacity', - _UNSPECIFIED: 'unspecified'}) +_dict = {COLOR: 'color', + OPACITY: 'opacity', + PRE_MULTIPLIED_OPACITY: 'pre-multiplied opacity', + _UNSPECIFIED: 'unspecified'} +_COLOR_TYPE_MAP_DISPLAY = _Keydefaultdict(_factory, _dict) # color channel definitions. RED = 1 @@ -153,4 +152,3 @@ _COLORSPACE = {SRGB: {"R": 1, "G": 2, "B": 3}, YCC: {"Y": 1, "Cb": 2, "Cr": 3}, E_SRGB: {"R": 1, "G": 2, "B": 3}, ROMM_RGB: {"R": 1, "G": 2, "B": 3}} - diff --git a/glymur/data/__init__.py b/glymur/data/__init__.py index de1e62a..066edd2 100644 --- a/glymur/data/__init__.py +++ b/glymur/data/__init__.py @@ -43,4 +43,3 @@ def jpxfile(): """ filename = pkg_resources.resource_filename(__name__, "heliov.jpx") return filename - diff --git a/glymur/jp2box.py b/glymur/jp2box.py index b2986ae..98b0e6a 100644 --- a/glymur/jp2box.py +++ b/glymur/jp2box.py @@ -11,8 +11,6 @@ References Extensions """ -# pylint: disable=C0302,R0903,R0913,W0142 - from collections import OrderedDict import datetime import io @@ -22,34 +20,37 @@ import pprint import struct import sys import textwrap -import uuid +from uuid import UUID import warnings import lxml.etree as ET import numpy as np from .codestream import Codestream -from .core import _COLORSPACE_MAP_DISPLAY -from .core import _COLOR_TYPE_MAP_DISPLAY -from .core import SRGB, GREYSCALE, YCC -from .core import ENUMERATED_COLORSPACE, RESTRICTED_ICC_PROFILE -from .core import ANY_ICC_PROFILE, VENDOR_COLOR_METHOD -from .core import _Keydefaultdict +from .core import (_COLORSPACE_MAP_DISPLAY, _COLOR_TYPE_MAP_DISPLAY, + SRGB, GREYSCALE, YCC, + ENUMERATED_COLORSPACE, RESTRICTED_ICC_PROFILE, + ANY_ICC_PROFILE, VENDOR_COLOR_METHOD, + _Keydefaultdict) from . import _uuid_io -_METHOD_DISPLAY = { - ENUMERATED_COLORSPACE: 'enumerated colorspace', - RESTRICTED_ICC_PROFILE: 'restricted ICC profile', - ANY_ICC_PROFILE: 'any ICC profile', - VENDOR_COLOR_METHOD: 'vendor color method'} +_factory = lambda x: '{0} (invalid)'.format(x) +_keysvalues = {ENUMERATED_COLORSPACE: 'enumerated colorspace', + RESTRICTED_ICC_PROFILE: 'restricted ICC profile', + ANY_ICC_PROFILE: 'any ICC profile', + VENDOR_COLOR_METHOD: 'vendor color method'} +_METHOD_DISPLAY = _Keydefaultdict(_factory, _keysvalues) _factory = lambda x: '{0} (invalid)'.format(x) -_APPROX_DISPLAY = _Keydefaultdict(_factory, - {1: 'accurately represents correct colorspace definition', - 2: 'approximates correct colorspace definition, exceptional quality', - 3: 'approximates correct colorspace definition, reasonable quality', - 4: 'approximates correct colorspace definition, poor quality'}) +_keysvalues = {1: 'accurately represents correct colorspace definition', + 2: ('approximates correct colorspace definition, ' + 'exceptional quality'), + 3: ('approximates correct colorspace definition, ' + 'reasonable quality'), + 4: 'approximates correct colorspace definition, poor quality'} +_APPROX_DISPLAY = _Keydefaultdict(_factory, _keysvalues) + class Jp2kBox(object): """Superclass for JPEG 2000 boxes. @@ -62,17 +63,13 @@ class Jp2kBox(object): length of the box in bytes. offset : int offset of the box from the start of the file. - longname : str - more verbose description of the box. box : list List of JPEG 2000 boxes. """ - def __init__(self, box_id='', offset=0, length=0, longname=''): - self.box_id = box_id + def __init__(self, offset=0, length=0): self.length = length self.offset = offset - self.longname = longname self.box = [] def __repr__(self): @@ -112,7 +109,6 @@ class Jp2kBox(object): msg += '\n' + self._indent(boxstr) return msg - def _indent(self, textstr, indent_level=4): """ Indent a string. @@ -138,7 +134,6 @@ class Jp2kBox(object): lst = [(' ' * indent_level + x) for x in textstr.split('\n')] return '\n'.join(lst) - def _write_superbox(self, fptr, box_id): """Write a superbox. @@ -194,13 +189,14 @@ class Jp2kBox(object): try: box = parser(fptr, start, num_bytes) except ValueError as err: - msg = "Encountered an unrecoverable ValueError while parsing a {0} " - msg += "box at byte offset {1}. The original error message was " - msg += "\"{2}\"" - msg = msg.format(box_id.decode('utf-8'), start, str(err)) + msg = "Encountered an unrecoverable ValueError while parsing a " + msg += "{0} box at byte offset {1}. The original error message " + msg += "was \"{2}\"" + msg = msg.format(_BOX_WITH_ID[box_id].longname, start, str(err)) warnings.warn(msg, UserWarning) box = UnknownBox(box_id.decode('utf-8'), - length=num_bytes, offset=start, longname='Unknown') + length=num_bytes, + offset=start, longname='Unknown') return box @@ -300,11 +296,13 @@ class ColourSpecificationBox(Jp2kBox): ICC profile header according to ICC profile specification. If colorspace is not None, then icc_profile must be empty. """ + longname = 'Colour Specification' + box_id = 'colr' def __init__(self, method=ENUMERATED_COLORSPACE, precedence=0, approximation=0, colorspace=None, icc_profile=None, length=0, offset=-1): - Jp2kBox.__init__(self, box_id='colr', longname='Colour Specification') + Jp2kBox.__init__(self) self.method = method self.precedence = precedence @@ -339,16 +337,16 @@ class ColourSpecificationBox(Jp2kBox): if self.icc_profile is None: if self.colorspace not in [SRGB, GREYSCALE, YCC]: - msg = "Colorspace should correspond to one of SRGB, GREYSCALE, " - msg += "or YCC." + msg = "Colorspace should correspond to one of SRGB, " + msg += "GREYSCALE, or YCC." self._dispatch_validation_error(msg, writing=True) self._validate(writing=True) - def __repr__(self): msg = "glymur.jp2box.ColourSpecificationBox(" - msg += "method={0}, precedence={1}, approximation={2}, colorspace={3}, " + msg += "method={0}, precedence={1}, approximation={2}, " + msg += "colorspace={3}, " msg += "icc_profile={4})" msg = msg.format(self.method, self.precedence, @@ -359,7 +357,7 @@ class ColourSpecificationBox(Jp2kBox): def __str__(self): msg = Jp2kBox.__str__(self) - if _printoptions['short'] == True: + if _printoptions['short'] is True: return msg msg += '\n Method: {0}'.format(_METHOD_DISPLAY[self.method]) @@ -588,8 +586,11 @@ class ChannelDefinitionBox(Jp2kBox): association : list index of the associated color """ + box_id = 'cdef' + longname = 'Channel Definition' + def __init__(self, channel_type, association, index=None, **kwargs): - Jp2kBox.__init__(self, box_id='cdef', longname='Channel Definition') + Jp2kBox.__init__(self) if index is None: self.index = tuple(range(len(channel_type))) @@ -618,10 +619,9 @@ class ChannelDefinitionBox(Jp2kBox): msg += " 65535 - unspecified" self._dispatch_validation_error(msg, writing=writing) - def __str__(self): msg = Jp2kBox.__str__(self) - if _printoptions['short'] == True: + if _printoptions['short'] is True: return msg for j in range(len(self.association)): @@ -704,8 +704,11 @@ class CodestreamHeaderBox(Jp2kBox): box : list List of boxes contained in this superbox. """ + box_id = 'jpch' + longname = 'Codestream Header' + def __init__(self, box=None, length=0, offset=-1): - Jp2kBox.__init__(self, box_id='jpch', longname='Codestream Header') + Jp2kBox.__init__(self) self.length = length self.offset = offset self.box = box if box is not None else [] @@ -765,8 +768,11 @@ class ColourGroupBox(Jp2kBox): box : list List of boxes contained in this superbox. """ + box_id = 'cgrp' + longname = 'Colour Group' + def __init__(self, box=None, length=0, offset=-1): - Jp2kBox.__init__(self, box_id='cgrp', longname='Colour Group') + Jp2kBox.__init__(self) self.length = length self.offset = offset self.box = box if box is not None else [] @@ -834,9 +840,11 @@ class CompositingLayerHeaderBox(Jp2kBox): box : list List of boxes contained in this superbox. """ + box_id = 'jplh' + longname = 'Compositing Layer Header' + def __init__(self, box=None, length=0, offset=-1): - Jp2kBox.__init__(self, box_id='jplh', - longname='Compositing Layer Header') + Jp2kBox.__init__(self) self.length = length self.offset = offset self.box = box if box is not None else [] @@ -900,9 +908,12 @@ class ComponentMappingBox(Jp2kBox): palette_index : tuple Index component from palette """ + box_id = 'cmap' + longname = 'Component Mapping' + def __init__(self, component_index, mapping_type, palette_index, length=0, offset=-1): - Jp2kBox.__init__(self, box_id='cmap', longname='Component Mapping') + Jp2kBox.__init__(self) self.component_index = component_index self.mapping_type = mapping_type self.palette_index = palette_index @@ -919,7 +930,7 @@ class ComponentMappingBox(Jp2kBox): def __str__(self): msg = Jp2kBox.__str__(self) - if _printoptions['short'] == True: + if _printoptions['short'] is True: return msg for k in range(len(self.component_index)): @@ -990,15 +1001,19 @@ class ContiguousCodestreamBox(Jp2kBox): offset of the box from the start of the file. longname : str more verbose description of the box. - main_header : Codestream object - contains list of main header marker/segments + codestream : Codestream object + Contains list of codestream marker/segments. By default, only the main + header is retrieved. main_header_offset : int offset of main header from start of file """ - def __init__(self, main_header=None, main_header_offset=None, length=0, + box_id = 'jp2c' + longname = 'Contiguous Codestream' + + def __init__(self, codestream=None, main_header_offset=None, length=0, offset=-1): - Jp2kBox.__init__(self, box_id='jp2c', longname='Contiguous Codestream') - self._main_header = main_header + Jp2kBox.__init__(self) + self._codestream = codestream self.length = length self.offset = offset self.main_header_offset = main_header_offset @@ -1007,29 +1022,33 @@ class ContiguousCodestreamBox(Jp2kBox): self._filename = None @property - def main_header(self): - if self._main_header is None: + def codestream(self): + if _parseoptions['full_codestream'] is True: + header_only = False + else: + header_only = True + if self._codestream is None: if self._filename is not None: with open(self._filename, 'rb') as fptr: fptr.seek(self.main_header_offset) - main_header = Codestream(fptr, self._length, header_only=True) - self._main_header = main_header - return self._main_header + codestream = Codestream(fptr, self._length, + header_only=header_only) + self._codestream = codestream + return self._codestream def __repr__(self): - msg = "glymur.jp2box.ContiguousCodeStreamBox(main_header={0})" - return msg.format(repr(self.main_header)) + msg = "glymur.jp2box.ContiguousCodeStreamBox(codestream={0})" + return msg.format(repr(self.codestream)) def __str__(self): msg = Jp2kBox.__str__(self) - if _printoptions['short'] == True: + if _printoptions['short'] is True: return msg - if _printoptions['codestream'] == False: + if _printoptions['codestream'] is False: return msg - msg += '\n Main header:' - for segment in self.main_header.segment: - msg += '\n' + self._indent(str(segment), indent_level=8) + for segment in self.codestream.segment: + msg += '\n' + self._indent(str(segment), indent_level=4) return msg @@ -1051,11 +1070,11 @@ class ContiguousCodestreamBox(Jp2kBox): ContiguousCodestreamBox instance """ main_header_offset = fptr.tell() - if _parseoptions['codestream'] is True: - main_header = Codestream(fptr, length, header_only=True) + if _parseoptions['full_codestream'] is True: + codestream = Codestream(fptr, length, header_only=False) else: - main_header = None - box = cls(main_header, main_header_offset=main_header_offset, + codestream = None + box = cls(codestream, main_header_offset=main_header_offset, length=length, offset=offset) box._filename = fptr.name box._length = length @@ -1078,8 +1097,11 @@ class DataReferenceBox(Jp2kBox): DR : list Data Entry URL boxes. """ + box_id = 'dtbl' + longname = 'Data Reference' + def __init__(self, data_entry_url_boxes=None, length=0, offset=-1): - Jp2kBox.__init__(self, box_id='dtbl', longname='Data Reference') + Jp2kBox.__init__(self) if data_entry_url_boxes is None: self.DR = [] else: @@ -1100,7 +1122,8 @@ class DataReferenceBox(Jp2kBox): """Verify that the box obeys the specifications for writing. """ if len(self.DR) == 0: - msg = "A data reference box cannot be empty when written to a file." + msg = "A data reference box cannot be empty when written to a " + msg += "file." self._dispatch_validation_error(msg, writing=True) self._validate(writing=True) @@ -1127,7 +1150,7 @@ class DataReferenceBox(Jp2kBox): def __str__(self): msg = Jp2kBox.__str__(self) - if _printoptions['short'] == True: + if _printoptions['short'] is True: return msg for box in self.DR: @@ -1205,9 +1228,12 @@ class FileTypeBox(Jp2kBox): compatibility_list: list List of file conformance profiles. """ + box_id = 'ftyp' + longname = 'File Type' + def __init__(self, brand='jp2 ', minor_version=0, compatibility_list=None, length=0, offset=-1): - Jp2kBox.__init__(self, box_id='ftyp', longname='File Type') + Jp2kBox.__init__(self) self.brand = brand self.minor_version = minor_version if compatibility_list is None: @@ -1227,7 +1253,7 @@ class FileTypeBox(Jp2kBox): def __str__(self): msg = Jp2kBox.__str__(self) - if _printoptions['short'] == True: + if _printoptions['short'] is True: return msg lst = [msg, @@ -1290,12 +1316,18 @@ class FileTypeBox(Jp2kBox): brand = brand.decode('utf-8') # Extract the compatibility list. Each entry has 4 bytes. - num_entries = int((length - 16)/ 4) + num_entries = int((length - 16) / 4) compatibility_list = [] for j in range(int(num_entries)): entry, = struct.unpack_from('>4s', read_buffer, 8 + j * 4) if sys.hexversion >= 0x03000000: - entry = entry.decode('utf-8') + try: + entry = entry.decode('utf-8') + except UnicodeDecodeError: + # The entry is invalid, but we've got code to catch this + # later on. + pass + compatibility_list.append(entry) return cls(brand=brand, minor_version=minor_version, @@ -1317,9 +1349,12 @@ class FragmentListBox(Jp2kBox): longname : str more verbose description of the box. """ + box_id = 'flst' + longname = 'Fragment List' + def __init__(self, fragment_offset, fragment_length, data_reference, length=0, offset=-1): - Jp2kBox.__init__(self, box_id='flst', longname='Fragment List') + Jp2kBox.__init__(self) self.fragment_offset = fragment_offset self.fragment_length = fragment_length self.data_reference = data_reference @@ -1350,7 +1385,7 @@ class FragmentListBox(Jp2kBox): def __str__(self): msg = Jp2kBox.__str__(self) - if _printoptions['short'] == True: + if _printoptions['short'] is True: return msg for j in range(len(self.fragment_offset)): @@ -1423,15 +1458,21 @@ class FragmentTableBox(Jp2kBox): longname : str more verbose description of the box. """ + box_id = 'ftbl' + longname = 'Fragment Table' + def __init__(self, box=None, length=0, offset=-1): - Jp2kBox.__init__(self, box_id='ftbl', longname='Fragment Table') + Jp2kBox.__init__(self) self.length = length self.offset = offset self.box = box if box is not None else [] def __repr__(self): msg = "glymur.jp2box.FragmentTableBox(box={0})" - msg = msg.format(None) if (len(self.box) == 0) else msg.format(self.box) + if len(self.box) == 0: + msg = msg.format(None) + else: + msg = msg.format(self.box) return msg def __str__(self): @@ -1478,7 +1519,6 @@ class FragmentTableBox(Jp2kBox): self._write_superbox(fptr, b'ftbl') - class FreeBox(Jp2kBox): """Container for JPX free box information. @@ -1493,8 +1533,11 @@ class FreeBox(Jp2kBox): longname : str more verbose description of the box. """ + box_id = 'free' + longname = 'Free' + def __init__(self, length=0, offset=-1): - Jp2kBox.__init__(self, box_id='free', longname='Free') + Jp2kBox.__init__(self) self.length = length self.offset = offset @@ -1504,7 +1547,7 @@ class FreeBox(Jp2kBox): def __str__(self): msg = Jp2kBox.__str__(self) - if _printoptions['short'] == True: + if _printoptions['short'] is True: return msg return msg @@ -1558,6 +1601,9 @@ class ImageHeaderBox(Jp2kBox): False if the file does not contain intellectual propery rights information. """ + box_id = 'ihdr' + longname = 'Image Header' + def __init__(self, height, width, num_components=1, signed=False, bits_per_component=8, compression=7, colorspace_unknown=False, ip_provided=False, length=0, offset=-1): @@ -1567,7 +1613,7 @@ class ImageHeaderBox(Jp2kBox): >>> import glymur >>> box = glymur.jp2box.ImageHeaderBox(height=512, width=256) """ - Jp2kBox.__init__(self, box_id='ihdr', longname='Image Header') + Jp2kBox.__init__(self) self.height = height self.width = width self.num_components = num_components @@ -1597,7 +1643,7 @@ class ImageHeaderBox(Jp2kBox): def __str__(self): msg = Jp2kBox.__str__(self) - if _printoptions['short'] == True: + if _printoptions['short'] is True: return msg msg = "{0}" @@ -1686,8 +1732,11 @@ class AssociationBox(Jp2kBox): box : list List of boxes contained in this superbox. """ + box_id = 'asoc' + longname = 'Association' + def __init__(self, box=None, length=0, offset=-1): - Jp2kBox.__init__(self, box_id='asoc', longname='Association') + Jp2kBox.__init__(self) self.length = length self.offset = offset self.box = box if box is not None else [] @@ -1747,8 +1796,11 @@ class JP2HeaderBox(Jp2kBox): box : list List of boxes contained in this superbox. """ + box_id = 'jp2h' + longname = 'JP2 Header' + def __init__(self, box=None, length=0, offset=-1): - Jp2kBox.__init__(self, box_id='jp2h', longname='JP2 Header') + Jp2kBox.__init__(self) self.length = length self.offset = offset self.box = box if box is not None else [] @@ -1808,8 +1860,11 @@ class JPEG2000SignatureBox(Jp2kBox): signature : tuple Four-byte tuple identifying the file as JPEG 2000. """ + box_id = 'jP ' + longname = 'JPEG 2000 Signature' + def __init__(self, signature=(13, 10, 135, 10), length=0, offset=-1): - Jp2kBox.__init__(self, box_id='jP ', longname='JPEG 2000 Signature') + Jp2kBox.__init__(self) self.signature = signature self.length = length self.offset = offset @@ -1819,7 +1874,7 @@ class JPEG2000SignatureBox(Jp2kBox): def __str__(self): msg = Jp2kBox.__str__(self) - if _printoptions['short'] == True: + if _printoptions['short'] is True: return msg msg += '\n Signature: {0:02x}{1:02x}{2:02x}{3:02x}' @@ -1872,9 +1927,12 @@ class PaletteBox(Jp2kBox): palette : ndarray Colormap array. """ + longname = 'Palette' + box_id = 'pclr' + def __init__(self, palette, bits_per_component, signed, length=0, offset=-1): - Jp2kBox.__init__(self, box_id='pclr', longname='Palette') + Jp2kBox.__init__(self) self.palette = palette self.bits_per_component = bits_per_component self.signed = signed @@ -1905,7 +1963,7 @@ class PaletteBox(Jp2kBox): def __str__(self): msg = Jp2kBox.__str__(self) - if _printoptions['short'] == True: + if _printoptions['short'] is True: return msg msg += '\n Size: ({0} x {1})'.format(*self.palette.shape) @@ -1935,7 +1993,6 @@ class PaletteBox(Jp2kBox): *bps_signed) fptr.write(write_buffer) - bps = self.bits_per_component # All components are the same. Writing is straightforward. if self.bits_per_component[0] <= 8: write_buffer = memoryview(self.palette.astype(np.uint8)) @@ -1975,13 +2032,10 @@ class PaletteBox(Jp2kBox): # Ok the palette has the same datatype for all columns. We should # be able to efficiently read it. if bps[0] <= 8: - nbytes_per_row = ncols dtype = np.uint8 elif bps[0] <= 16: - nbytes_per_row = 2 * ncols dtype = np.uint16 elif bps[0] <= 32: - nbytes_per_row = 3 * ncols dtype = np.uint32 palette = np.frombuffer(read_buffer[3 + ncols:], dtype=dtype) @@ -2025,80 +2079,80 @@ _READER_REQUIREMENTS_DISPLAY = { 7: 'JPEG codestream as defined in ISO/IEC 10918-1', 8: 'Deprecated - does not contain opacity', 9: 'Non-premultiplied opacity channel', - 10: 'Premultiplied opacity channel', - 11: 'Chroma-key based opacity', - 12: 'Deprecated - codestream is contiguous', - 13: 'Fragmented codestream where all fragments are in file and in order', - 14: 'Fragmented codestream where all fragments are in file ' - + 'but are out of order', - 15: 'Fragmented codestream where not all fragments are within the file ' - + 'but are all in locally accessible files', - 16: 'Fragmented codestream where some fragments may be accessible ' - + 'only through a URL specified network connection', - 17: 'Compositing required to produce rendered result from multiple ' - + 'compositing layers', - 18: 'Deprecated - support for compositing is not required', - 19: 'Deprecated - contains multiple, discrete layers that should not ' - + 'be combined through either animation or compositing', - 20: 'Deprecated - compositing layers each contain only a single ' - + 'codestream', - 21: 'At least one compositing layer consists of multiple codestreams', - 22: 'Deprecated - all compositing layers are in the same colourspace', - 23: 'Colourspace transformations are required to combine compositing ' - + 'layers; not all compositing layers are in the same colourspace', - 24: 'Deprecated - rendered result created without using animation', - 25: 'Deprecated - animated, but first layer covers entire area and is ' - + 'opaque', - 26: 'First animation layer does not cover entire rendered result', - 27: 'Deprecated - animated, and no layer is reused', - 28: 'Reuse of animation layers', - 29: 'Deprecated - animated, but layers are reused', - 30: 'Some animated frames are non-persistent', - 31: 'Deprecated - rendered result created without using scaling', - 32: 'Rendered result involves scaling within a layer', - 33: 'Rendered result involves scaling between layers', - 34: 'ROI metadata', - 35: 'IPR metadata', - 36: 'Content metadata', - 37: 'History metadata', - 38: 'Creation metadata', - 39: 'JPX digital signatures', - 40: 'JPX checksums', - 41: 'Desires Graphics Arts Reproduction specified', - 42: 'Deprecated - compositing layer uses palettized colour', - 43: 'Deprecated - compositing layer uses restricted ICC profile', - 44: 'Compositing layer uses Any ICC profile', - 45: 'Deprecated - compositing layer uses sRGB enumerated colourspace', - 46: 'Deprecated - compositing layer uses sRGB-grey enumerated colourspace', - 47: 'BiLevel 1 enumerated colourspace', - 48: 'BiLevel 2 enumerated colourspace', - 49: 'YCbCr 1 enumerated colourspace', - 50: 'YCbCr 2 enumerated colourspace', - 51: 'YCbCr 3 enumerated colourspace', - 52: 'PhotoYCC enumerated colourspace', - 53: 'YCCK enumerated colourspace', - 54: 'CMY enumerated colourspace', - 55: 'CMYK enumerated colorspace', - 56: 'CIELab enumerated colourspace with default parameters', - 57: 'CIELab enumerated colourspace with non-default parameters', - 58: 'CIEJab enumerated colourspace with default parameters', - 59: 'CIEJab enumerated colourspace with non-default parameters', - 60: 'e-sRGB enumerated colorspace', - 61: 'ROMM_RGB enumerated colorspace', - 62: 'Non-square samples', - 63: 'Deprecated - compositing layers have labels', - 64: 'Deprecated - codestreams have labels', - 65: 'Deprecated - compositing layers have different colour spaces', - 66: 'Deprecated - compositing layers have different metadata', - 67: 'GIS metadata XML box', - 68: 'JPSEC extensions in codestream as specified by ISO/IEC 15444-8', - 69: 'JP3D extensions in codestream as specified by ISO/IEC 15444-10', - 70: 'Deprecated - compositing layer uses sYCC enumerated colour space', - 71: 'e-sYCC enumerated colourspace', - 72: 'JPEG 2000 Part 2 codestream as restricted by baseline conformance ' - + 'requirements in M.9.2.3', - 73: 'YPbPr(1125/60) enumerated colourspace', - 74: 'YPbPr(1250/50) enumerated colourspace'} + 10: 'Premultiplied opacity channel', + 11: 'Chroma-key based opacity', + 12: 'Deprecated - codestream is contiguous', + 13: 'Fragmented codestream where all fragments are in file and in order', + 14: ('Fragmented codestream where all fragments are in file ' + 'but are out of order'), + 15: ('Fragmented codestream where not all fragments are within the file ' + 'but are all in locally accessible files'), + 16: ('Fragmented codestream where some fragments may be accessible ' + 'only through a URL specified network connection'), + 17: ('Compositing required to produce rendered result from multiple ' + 'compositing layers'), + 18: 'Deprecated - support for compositing is not required', + 19: ('Deprecated - contains multiple, discrete layers that should not ' + 'be combined through either animation or compositing'), + 20: ('Deprecated - compositing layers each contain only a single ' + 'codestream'), + 21: 'At least one compositing layer consists of multiple codestreams', + 22: 'Deprecated - all compositing layers are in the same colourspace', + 23: ('Colourspace transformations are required to combine compositing ' + 'layers; not all compositing layers are in the same colourspace'), + 24: 'Deprecated - rendered result created without using animation', + 25: ('Deprecated - animated, but first layer covers entire area and is ' + 'opaque'), + 26: 'First animation layer does not cover entire rendered result', + 27: 'Deprecated - animated, and no layer is reused', + 28: 'Reuse of animation layers', + 29: 'Deprecated - animated, but layers are reused', + 30: 'Some animated frames are non-persistent', + 31: 'Deprecated - rendered result created without using scaling', + 32: 'Rendered result involves scaling within a layer', + 33: 'Rendered result involves scaling between layers', + 34: 'ROI metadata', + 35: 'IPR metadata', + 36: 'Content metadata', + 37: 'History metadata', + 38: 'Creation metadata', + 39: 'JPX digital signatures', + 40: 'JPX checksums', + 41: 'Desires Graphics Arts Reproduction specified', + 42: 'Deprecated - compositing layer uses palettized colour', + 43: 'Deprecated - compositing layer uses restricted ICC profile', + 44: 'Compositing layer uses Any ICC profile', + 45: 'Deprecated - compositing layer uses sRGB enumerated colourspace', + 46: 'Deprecated - compositing layer uses sRGB-grey enumerated colourspace', + 47: 'BiLevel 1 enumerated colourspace', + 48: 'BiLevel 2 enumerated colourspace', + 49: 'YCbCr 1 enumerated colourspace', + 50: 'YCbCr 2 enumerated colourspace', + 51: 'YCbCr 3 enumerated colourspace', + 52: 'PhotoYCC enumerated colourspace', + 53: 'YCCK enumerated colourspace', + 54: 'CMY enumerated colourspace', + 55: 'CMYK enumerated colorspace', + 56: 'CIELab enumerated colourspace with default parameters', + 57: 'CIELab enumerated colourspace with non-default parameters', + 58: 'CIEJab enumerated colourspace with default parameters', + 59: 'CIEJab enumerated colourspace with non-default parameters', + 60: 'e-sRGB enumerated colorspace', + 61: 'ROMM_RGB enumerated colorspace', + 62: 'Non-square samples', + 63: 'Deprecated - compositing layers have labels', + 64: 'Deprecated - codestreams have labels', + 65: 'Deprecated - compositing layers have different colour spaces', + 66: 'Deprecated - compositing layers have different metadata', + 67: 'GIS metadata XML box', + 68: 'JPSEC extensions in codestream as specified by ISO/IEC 15444-8', + 69: 'JP3D extensions in codestream as specified by ISO/IEC 15444-10', + 70: 'Deprecated - compositing layer uses sYCC enumerated colour space', + 71: 'e-sYCC enumerated colourspace', + 72: ('JPEG 2000 Part 2 codestream as restricted by baseline conformance ' + 'requirements in M.9.2.3'), + 73: 'YPbPr(1125/60) enumerated colourspace', + 74: 'YPbPr(1250/50) enumerated colourspace'} class ReaderRequirementsBox(Jp2kBox): @@ -2129,9 +2183,12 @@ class ReaderRequirementsBox(Jp2kBox): Specifies the compatibility mask for each corresponding vendor feature. """ + box_id = 'rreq' + longname = 'Reader Requirements' + def __init__(self, fuam, dcm, standard_flag, standard_mask, vendor_feature, vendor_mask, length=0, offset=-1): - Jp2kBox.__init__(self, box_id='rreq', longname='Reader Requirements') + Jp2kBox.__init__(self) self.fuam = fuam self.dcm = dcm self.standard_flag = tuple(standard_flag) @@ -2155,10 +2212,11 @@ class ReaderRequirementsBox(Jp2kBox): def __str__(self): msg = Jp2kBox.__str__(self) - if _printoptions['short'] == True: + if _printoptions['short'] is True: return msg - msg += '\n Fully Understands Aspect Mask: 0x{0:x}'.format(self.fuam) + msg += '\n Fully Understands Aspect Mask: 0x{0:x}' + msg = msg.format(self.fuam) msg += '\n Display Completely Mask: 0x{0:x}'.format(self.dcm) msg += '\n Standard Features and Masks:' @@ -2214,7 +2272,8 @@ class ReaderRequirementsBox(Jp2kBox): standard_flag, standard_mask = data nflags = len(standard_flag) - vendor_offset = 1 + 2 * mask_length + 2 + (2 + mask_length) * nflags + vendor_offset = (1 + 2 * mask_length + 2 + + (2 + mask_length) * nflags) data = _parse_vendor_features(read_buffer[vendor_offset:], mask_length) vendor_feature, vendor_mask = data @@ -2271,8 +2330,8 @@ def _parse_rreq3(read_buffer, length, offset): read_buffer = read_buffer[9 + num_standard_features * 10:] for j in range(num_vendor_features): uslice = slice(j * entry_length, (j + 1) * entry_length) - ubuffer = read_buffer[slice] - vendor_feature.append(uuid.UUID(bytes=ubuffer[0:16])) + ubuffer = read_buffer[uslice] + vendor_feature.append(UUID(bytes=ubuffer[0:16])) lst = struct.unpack('>BBB', ubuffer[16:]) vmask = lst[0] << 16 | lst[1] << 8 | lst[2] @@ -2300,14 +2359,11 @@ def _parse_standard_flag(read_buffer, mask_length): # from the buffer read from file. mask_format = {1: 'B', 2: 'H', 4: 'I'}[mask_length] - #read_buffer = fptr.read(2) num_standard_flags, = struct.unpack_from('>H', read_buffer, offset=0) # Read in standard flags and standard masks. Each standard flag should # be two bytes, but the standard mask flag is as long as specified by # the mask length. - #read_buffer = fptr.read(num_standard_flags * (2 + mask_length)) - fmt = '>' + ('H' + mask_format) * num_standard_flags data = struct.unpack_from(fmt, read_buffer, offset=2) @@ -2338,13 +2394,12 @@ def _parse_vendor_features(read_buffer, mask_length): # Each vendor feature consists of a 16-byte UUID plus a mask whose # length is specified by, you guessed it, "mask_length". entry_length = 16 + mask_length - #read_buffer = fptr.read(num_vendor_features * entry_length) vendor_feature = [] vendor_mask = [] for j in range(num_vendor_features): uslice = slice(2 + j * entry_length, 2 + (j + 1) * entry_length) ubuffer = read_buffer[uslice] - vendor_feature.append(uuid.UUID(bytes=ubuffer[0:16])) + vendor_feature.append(UUID(bytes=ubuffer[0:16])) vmask = struct.unpack('>' + mask_format, ubuffer[16:]) vendor_mask.append(vmask) @@ -2368,8 +2423,11 @@ class ResolutionBox(Jp2kBox): box : list List of boxes contained in this superbox. """ + box_id = 'res ' + longname = 'Resolution' + def __init__(self, box=None, length=0, offset=-1): - Jp2kBox.__init__(self, box_id='res ', longname='Resolution') + Jp2kBox.__init__(self) self.length = length self.offset = offset self.box = box if box is not None else [] @@ -2425,9 +2483,12 @@ class CaptureResolutionBox(Jp2kBox): vertical_resolution, horizontal_resolution : float Vertical, horizontal resolution. """ + box_id = 'resc' + longname = 'Capture Resolution' + def __init__(self, vertical_resolution, horizontal_resolution, length=0, offset=-1): - Jp2kBox.__init__(self, box_id='resc', longname='Capture Resolution') + Jp2kBox.__init__(self) self.vertical_resolution = vertical_resolution self.horizontal_resolution = horizontal_resolution self.length = length @@ -2440,7 +2501,7 @@ class CaptureResolutionBox(Jp2kBox): def __str__(self): msg = Jp2kBox.__str__(self) - if _printoptions['short'] == True: + if _printoptions['short'] is True: return msg msg += '\n VCR: {0}'.format(self.vertical_resolution) @@ -2488,9 +2549,12 @@ class DisplayResolutionBox(Jp2kBox): vertical_resolution, horizontal_resolution : float Vertical, horizontal resolution. """ + box_id = 'resd' + longname = 'Display Resolution' + def __init__(self, vertical_resolution, horizontal_resolution, length=0, offset=-1): - Jp2kBox.__init__(self, box_id='resd', longname='Display Resolution') + Jp2kBox.__init__(self) self.vertical_resolution = vertical_resolution self.horizontal_resolution = horizontal_resolution self.length = length @@ -2503,7 +2567,7 @@ class DisplayResolutionBox(Jp2kBox): def __str__(self): msg = Jp2kBox.__str__(self) - if _printoptions['short'] == True: + if _printoptions['short'] is True: return msg msg += '\n VDR: {0}'.format(self.vertical_resolution) @@ -2552,15 +2616,18 @@ class LabelBox(Jp2kBox): label : str Textual label. """ + box_id = 'lbl ' + longname = 'Label' + def __init__(self, label, length=0, offset=-1): - Jp2kBox.__init__(self, box_id='lbl ', longname='Label') + Jp2kBox.__init__(self) self.label = label self.length = length self.offset = offset def __str__(self): msg = Jp2kBox.__str__(self) - if _printoptions['short'] == True: + if _printoptions['short'] is True: return msg msg += '\n Label: {0}'.format(self.label) @@ -2617,15 +2684,18 @@ class NumberListBox(Jp2kBox): Descriptors of an entity with which the data contained within the same Association box is associated. """ + box_id = 'nlst' + longname = 'Number List' + def __init__(self, associations, length=0, offset=-1): - Jp2kBox.__init__(self, box_id='nlst', longname='Number List') + Jp2kBox.__init__(self) self.associations = associations self.length = length self.offset = offset def __str__(self): msg = Jp2kBox.__str__(self) - if _printoptions['short'] == True: + if _printoptions['short'] is True: return msg for j, association in enumerate(self.associations): @@ -2675,7 +2745,8 @@ class NumberListBox(Jp2kBox): def write(self, fptr): """Write a NumberList box to file. """ - fptr.write(struct.pack('>I4s', len(self.associations) * 4 + 8, b'nlst')) + fptr.write(struct.pack('>I4s', + len(self.associations) * 4 + 8, b'nlst')) fmt = '>' + 'I' * len(self.associations) write_buffer = struct.pack(fmt, *self.associations) @@ -2698,6 +2769,9 @@ class XMLBox(Jp2kBox): xml : ElementTree object XML section. """ + box_id = 'xml ' + longname = 'XML' + def __init__(self, xml=None, filename=None, length=0, offset=-1): """ Parameters @@ -2708,7 +2782,7 @@ class XMLBox(Jp2kBox): File from which to read XML. If filename is not None, then the xml keyword argument must be None. """ - Jp2kBox.__init__(self, box_id='xml ', longname='XML') + Jp2kBox.__init__(self) if filename is not None and xml is not None: msg = "Only one of either filename or xml should be provided." raise IOError(msg) @@ -2724,9 +2798,9 @@ class XMLBox(Jp2kBox): def __str__(self): msg = Jp2kBox.__str__(self) - if _printoptions['short'] == True: + if _printoptions['short'] is True: return msg - if _printoptions['xml'] == False: + if _printoptions['xml'] is False: return msg msg += '\n' @@ -2830,8 +2904,11 @@ class UUIDListBox(Jp2kBox): ulst : list List of UUIDs. """ + box_id = 'ulst' + longname = 'UUID List' + def __init__(self, ulst, length=0, offset=-1): - Jp2kBox.__init__(self, box_id='ulst', longname='UUID List') + Jp2kBox.__init__(self) self.ulst = ulst self.length = length self.offset = offset @@ -2842,7 +2919,7 @@ class UUIDListBox(Jp2kBox): def __str__(self): msg = Jp2kBox.__str__(self) - if _printoptions['short'] == True: + if _printoptions['short'] is True: return msg for j, uuid_item in enumerate(self.ulst): @@ -2873,8 +2950,8 @@ class UUIDListBox(Jp2kBox): ulst = [] for j in range(num_uuids): - uuid_buffer = read_buffer[2 + j * 16 : 2 + (j + 1) * 16] - ulst.append(uuid.UUID(bytes=uuid_buffer)) + uuid_buffer = read_buffer[2 + j * 16:2 + (j + 1) * 16] + ulst.append(UUID(bytes=uuid_buffer)) return cls(ulst, length=length, offset=offset) @@ -2895,8 +2972,11 @@ class UUIDInfoBox(Jp2kBox): box : list List of boxes contained in this superbox. """ + box_id = 'uinf' + longname = 'UUIDInfo' + def __init__(self, box=None, length=0, offset=-1): - Jp2kBox.__init__(self, box_id='uinf', longname='UUIDInfo') + Jp2kBox.__init__(self) self.length = length self.offset = offset self.box = box if box is not None else [] @@ -2956,8 +3036,11 @@ class DataEntryURLBox(Jp2kBox): URL : str Associated URL. """ + box_id = 'url ' + longname = 'Data Entry URL' + def __init__(self, version, flag, url, length=0, offset=-1): - Jp2kBox.__init__(self, box_id='url ', longname='Data Entry URL') + Jp2kBox.__init__(self) self.version = version self.flag = flag self.url = url @@ -2981,7 +3064,6 @@ class DataEntryURLBox(Jp2kBox): fptr.write(write_buffer) fptr.write(url) - def __repr__(self): msg = "glymur.jp2box.DataEntryURLBox({0}, {1}, '{2}')" msg = msg.format(self.version, self.flag, self.url) @@ -2989,7 +3071,7 @@ class DataEntryURLBox(Jp2kBox): def __str__(self): msg = Jp2kBox.__str__(self) - if _printoptions['short'] == True: + if _printoptions['short'] is True: return msg msg += '\n ' @@ -3045,7 +3127,9 @@ class UnknownBox(Jp2kBox): more verbose description of the box. """ def __init__(self, box_id, length=0, offset=-1, longname=''): - Jp2kBox.__init__(self, box_id=box_id, longname=longname) + Jp2kBox.__init__(self) + self.longname = longname + self.box_id = box_id self.length = length self.offset = offset @@ -3089,6 +3173,9 @@ class UUIDBox(Jp2kBox): 16684-1:2012 - Graphic technology -- Extensible metadata platform (XMP) specification -- Part 1: Data model, serialization and core properties """ + box_id = 'uuid' + longname = 'UUID' + def __init__(self, the_uuid, raw_data, length=0, offset=-1): """ Parameters @@ -3102,7 +3189,7 @@ class UUIDBox(Jp2kBox): offset : int offset of the box from the start of the file. """ - Jp2kBox.__init__(self, box_id='uuid', longname='UUID') + Jp2kBox.__init__(self) self.uuid = the_uuid self.raw_data = raw_data self.length = length @@ -3122,7 +3209,7 @@ class UUIDBox(Jp2kBox): """ Private function for parsing UUID payloads if possible. """ - if self.uuid == uuid.UUID('be7acfcb-97a9-42e8-9c71-999491e3afac'): + if self.uuid == UUID('be7acfcb-97a9-42e8-9c71-999491e3afac'): self.data = _uuid_io.xml(self.raw_data) elif self.uuid.bytes == b'JpgTiffExif->JP2': self.data = _uuid_io.tiff_header(self.raw_data) @@ -3136,23 +3223,23 @@ class UUIDBox(Jp2kBox): def __str__(self): msg = Jp2kBox.__str__(self) - if _printoptions['short'] == True: + if _printoptions['short'] is True: return msg msg = '{0}\n UUID: {1}'.format(msg, self.uuid) - if self.uuid == uuid.UUID('be7acfcb-97a9-42e8-9c71-999491e3afac'): + if self.uuid == UUID('be7acfcb-97a9-42e8-9c71-999491e3afac'): msg += ' (XMP)' elif self.uuid.bytes == b'JpgTiffExif->JP2': msg += ' (EXIF)' else: msg += ' (unknown)' - if (((_printoptions['xml'] == False) and - (self.uuid == uuid.UUID('be7acfcb-97a9-42e8-9c71-999491e3afac')))): + if (((_printoptions['xml'] is False) and + (self.uuid == UUID('be7acfcb-97a9-42e8-9c71-999491e3afac')))): # If it's an XMP UUID, don't print the XML contents. return msg - if self.uuid == uuid.UUID('be7acfcb-97a9-42e8-9c71-999491e3afac'): + if self.uuid == UUID('be7acfcb-97a9-42e8-9c71-999491e3afac'): line = '\n UUID Data:\n{0}' xmlstring = ET.tostring(self.data, encoding='utf-8', @@ -3195,7 +3282,7 @@ class UUIDBox(Jp2kBox): """ num_bytes = offset + length - fptr.tell() read_buffer = fptr.read(num_bytes) - the_uuid = uuid.UUID(bytes=read_buffer[0:16]) + the_uuid = UUID(bytes=read_buffer[0:16]) return cls(the_uuid, read_buffer[16:], length=length, offset=offset) @@ -3230,18 +3317,20 @@ _BOX_WITH_ID = { b'uuid': UUIDBox, b'xml ': XMLBox} -_parseoptions = {'codestream': True} +_parseoptions = {'full_codestream': False} -def set_parseoptions(codestream=True): + +def set_parseoptions(full_codestream=True): """Set parsing options. These options determine the way JPEG 2000 boxes are parsed. Parameters ---------- - codestream : bool, defaults to True - When False, the codestream header is only parsed when accessed. This - can results in faster JP2/JPX parsing. + full_codestream : bool, defaults to True + When False, only the codestream header is parsed for metadata. This + can results in faster JP2/JPX parsing. When True, the entire + codestream is parsed for metadata. See also -------- @@ -3252,9 +3341,10 @@ def set_parseoptions(codestream=True): To put back the default options, you can use: >>> import glymur - >>> glymur.set_parseoptions(codestream=True) + >>> glymur.set_parseoptions(full_codestream=True) """ - _parseoptions['codestream'] = codestream + _parseoptions['full_codestream'] = full_codestream + def get_parseoptions(): """Return the current parsing options. @@ -3276,6 +3366,7 @@ def get_parseoptions(): _printoptions = {'short': False, 'xml': True, 'codestream': True} + def set_printoptions(**kwargs): """Set printing options. @@ -3285,12 +3376,15 @@ def set_printoptions(**kwargs): ---------- short : bool, optional When True, only the box ID, offset, and length are displayed. Useful - for displaying only the basic structure or skeleton of a JPEG 2000 file. + for displaying only the basic structure or skeleton of a JPEG 2000 + file. xml : bool, optional When False, printing of the XML contents of any XML boxes or UUID XMP boxes is suppressed. codestream : bool, optional - When False, printing of the codestream contents is suppressed. + When False, only the codestream header is printed. When True, the + entire codestream is printed. This option has no effect when the + 'short' option is set to True. See also -------- @@ -3308,6 +3402,7 @@ def set_printoptions(**kwargs): raise TypeError('"{0}" not a valid keyword parameter.'.format(key)) _printoptions[key] = value + def get_printoptions(): """Return the current print options. @@ -3327,5 +3422,3 @@ def get_printoptions(): set_printoptions """ return _printoptions - - diff --git a/glymur/jp2dump.py b/glymur/jp2dump.py deleted file mode 100644 index c0f0f7f..0000000 --- a/glymur/jp2dump.py +++ /dev/null @@ -1,36 +0,0 @@ -""" -Entry point for jp2dump script. -""" -import warnings - -from .jp2k import Jp2k - - -def jp2dump(filename, codestream=False): - """Prints JPEG2000 metadata. - - Parameters - ---------- - filename : string - The input JPEG2000 file. - codestream : optional, logical scalar - Whether or not to dump codestream contents. - """ - with warnings.catch_warnings(record=True) as wctx: - - # JP2 metadata can be extensive, so don't print any warnings until we - # are done with the metadata. - j = Jp2k(filename) - if codestream: - print(j.get_codestream(header_only=False)) - else: - print(j) - - # Re-emit any warnings that may have been suppressed. - if len(wctx) > 0: - print("\n") - for warning in wctx: - print("{0}:{1}: {2}: {3}".format(warning.filename, - warning.lineno, - warning.category.__name__, - warning.message)) diff --git a/glymur/jp2k.py b/glymur/jp2k.py index 4ebd678..ee6eedc 100644 --- a/glymur/jp2k.py +++ b/glymur/jp2k.py @@ -10,11 +10,12 @@ License: MIT import sys # Exitstack not found in contextlib in 2.7 -# pylint: disable=E0611 if sys.hexversion >= 0x03030000: from contextlib import ExitStack + from itertools import filterfalse else: from contextlib2 import ExitStack + from itertools import ifilterfalse as filterfalse from collections import Counter import ctypes @@ -28,23 +29,12 @@ import warnings import numpy as np from .codestream import Codestream -from .core import SRGB, GREYSCALE -from .core import PROGRESSION_ORDER -from .core import ENUMERATED_COLORSPACE, RESTRICTED_ICC_PROFILE -from . import core -from .jp2box import Jp2kBox -from .jp2box import JPEG2000SignatureBox, FileTypeBox, JP2HeaderBox -from .jp2box import ColourSpecificationBox, ContiguousCodestreamBox -from .jp2box import ImageHeaderBox -from .lib import openjpeg as opj -from .lib import openjp2 as opj2 -from . import version -from .lib import c as libc +from . import core, version +from .jp2box import (Jp2kBox, JPEG2000SignatureBox, FileTypeBox, + JP2HeaderBox, ColourSpecificationBox, + ContiguousCodestreamBox, ImageHeaderBox) +from .lib import openjpeg as opj, openjp2 as opj2, c as libc -JP2_IDS = ['colr', 'cdef', 'cmap', 'jp2c', 'ftyp', 'ihdr', 'jp2h', 'jP ', - 'pclr', 'res ', 'resc', 'resd', 'xml ', 'ulst', 'uinf', 'url ', - 'uuid'] -JPX_IDS = ['asoc', 'nlst'] class Jp2k(Jp2kBox): """JPEG 2000 file. @@ -53,32 +43,200 @@ class Jp2k(Jp2kBox): ---------- filename : str The path to the JPEG 2000 file. - mode : str - The mode used to open the file. box : sequence List of top-level boxes in the file. Each box may in turn contain its own list of boxes. Will be empty if the file consists only of a raw codestream. + shape : tuple + Size of the image. + + Properties + ---------- + ignore_pclr_cmap_cdef : bool + whether or not to ignore the pclr, cmap, or cdef boxes during any + color transformation, defaults to False. + layer : int + zero-based number of quality layer to decode + verbose : bool + whether or not to print informational messages produced by the + OpenJPEG library, defaults to false + codestream : object + JP2 or J2K codestream object + + Examples + -------- + >>> import glymur + >>> jfile = glymur.data.nemo() + >>> jp2 = glymur.Jp2k(jfile) + >>> jp2.shape + (1456, 2592, 3) + >>> image = jp2[:] + >>> image.shape + (1456, 2592, 3) + + Read a lower resolution thumbnail. + + >>> thumbnail = jp2[::2, ::2] + >>> thumbnail.shape + (728, 1296, 3) """ - def __init__(self, filename, mode='rb'): + def __init__(self, filename, data=None, shape=None, **kwargs): """ + Only the filename parameter is required in order to read a JPEG 2000 + file. + Parameters ---------- filename : str or file - The path to JPEG 2000 file. - mode : str, optional - The mode used to open the file. + the path to JPEG 2000 file + image_data : ndarray, optional + image data to be written + shape : tuple + size of image data, only required when image_data is not provided + cbsize : tuple, optional + code block size (DY, DX) + cinema2k : int, optional + frames per second, either 24 or 48 + cinema4k : bool, optional + set to True to specify Cinema4K mode, defaults to false + colorspace : str, optional + either 'rgb' or 'gray' + cratios : iterable + compression ratios for successive layers + eph : bool, optional + if true, write SOP marker after each header packet + grid_offset : tuple, optional + offset (DY, DX) of the origin of the image in the reference grid + irreversible : bool, optional + if true, use the irreversible DWT 9-7 transform + mct : bool, optional + specifies usage of the multi component transform, if not + specified, defaults to True if the colorspace is RGB + modesw : int, optional + mode switch + 1 = BYPASS(LAZY) + 2 = RESET + 4 = RESTART(TERMALL) + 8 = VSC + 16 = ERTERM(SEGTERM) + 32 = SEGMARK(SEGSYM) + numres : int, optional + number of resolutions + prog : str, optional + progression order, one of "LRCP" "RLCP", "RPCL", "PCRL", "CPRL" + psnr : iterable, optional + different PSNR for successive layers + psizes : list, optional + list of precinct sizes, each precinct size tuple is defined in + (height x width) + sop : bool, optional + if true, write SOP marker before each packet + subsam : tuple, optional + subsampling factors (dy, dx) + tilesize : tuple, optional + numeric tuple specifying tile size in terms of (numrows, numcols), + not (X, Y) + verbose : bool, optional + print informational messages produced by the OpenJPEG library """ Jp2kBox.__init__(self) self.filename = filename - self.mode = mode + self.box = [] self._codec_format = None + self._colorspace = None + self._layer = 0 + self._codestream = None + if data is not None: + self._shape = data.shape + else: + self._shape = shape + + self._ignore_pclr_cmap_cdef = False + self._verbose = False # Parse the file for JP2/JPX contents only if we are reading it. - if mode == 'rb': + if data is None and shape is None: self.parse() + elif data is not None: + self._write(data, **kwargs) + + @property + def ignore_pclr_cmap_cdef(self): + return self._ignore_pclr_cmap_cdef + + @ignore_pclr_cmap_cdef.setter + def ignore_pclr_cmap_cdef(self, ignore_pclr_cmap_cdef): + self._ignore_pclr_cmap_cdef = ignore_pclr_cmap_cdef + + @property + def layer(self): + return self._layer + + @layer.setter + def layer(self, layer): + if version.openjpeg_version_tuple[0] < 2: + msg = "Layer property not supported unless the version of " + msg += "OpenJPEG is 2.0 or higher." + raise RuntimeError(msg) + self._layer = layer + + @property + def codestream(self): + if self._codestream is None: + self._codestream = self.get_codestream(header_only=True) + return self._codestream + + @codestream.setter + def codestream(self, the_codestream): + self._codestream = the_codestream + + @property + def verbose(self): + return self._verbose + + @verbose.setter + def verbose(self, verbose): + self._verbose = verbose + + @property + def shape(self): + if self._shape is not None: + return self._shape + + if self._codec_format == opj2.CODEC_J2K: + # get the image size from the codestream + cstr = self.codestream + height = cstr.segment[1].ysiz + width = cstr.segment[1].xsiz + num_components = len(cstr.segment[1].xrsiz) + else: + # try to get the image size from the IHDR box + jp2h = [box for box in self.box if box.box_id == 'jp2h'][0] + ihdr = [box for box in jp2h.box if box.box_id == 'ihdr'][0] + + height, width = ihdr.height, ihdr.width + num_components = ihdr.num_components + + if num_components == 1: + # but if there is a PCLR box, then we need to check that as + # well, as that turns a single-channel image into a + # multi-channel image + pclr = [box for box in jp2h.box if box.box_id == 'pclr'] + if len(pclr) > 0: + num_components = len(pclr[0].signed) + + if num_components == 1: + self.shape = (height, width) + else: + self.shape = (height, width, num_components) + + return self._shape + + @shape.setter + def shape(self, shape): + self._shape = shape def __repr__(self): msg = "glymur.Jp2k('{0}')".format(self.filename) @@ -90,8 +248,7 @@ class Jp2k(Jp2kBox): for box in self.box: metadata.append(str(box)) else: - codestream = self.get_codestream() - metadata.append(str(codestream)) + metadata.append(str(self.codestream)) return '\n'.join(metadata) def parse(self): @@ -148,14 +305,14 @@ class Jp2k(Jp2kBox): jp2h = [box for box in self.box if box.box_id == 'jp2h'][0] colrs = [box for box in jp2h.box if box.box_id == 'colr'] for colr in colrs: - if colr.method not in (ENUMERATED_COLORSPACE, - RESTRICTED_ICC_PROFILE): + if colr.method not in (core.ENUMERATED_COLORSPACE, + core.RESTRICTED_ICC_PROFILE): msg = "Color Specification box method must specify either " msg += "an enumerated colorspace or a restricted ICC " msg += "profile if the file type box brand is 'jp2 '." warnings.warn(msg) - def _set_cinema_params(self, cparams, cinema_mode, fps): + def _set_cinema_params(self, cinema_mode, fps): """Populate compression parameters structure for cinema2K. Parameters @@ -168,11 +325,14 @@ class Jp2k(Jp2kBox): fps : int Frames per second, should be either 24 or 48. """ - if re.match("(1.5|2.0.0)", version.openjpeg_version) is not None: + if re.match("1.5|2.0.0", version.openjpeg_version) is not None: msg = "Writing Cinema2K or Cinema4K files is not supported with " msg += 'openjpeg library versions less than 2.0.1.' raise IOError(msg) + # Cinema modes imply MCT. + self._cparams.tcp_mct = 1 + if cinema_mode == 'cinema2k': if fps not in [24, 48]: raise IOError('Cinema2K frame rate must be either 24 or 48.') @@ -180,77 +340,48 @@ class Jp2k(Jp2kBox): if re.match("2.0", version.openjpeg_version) is not None: # 2.0 API if fps == 24: - cparams.cp_cinema = core.OPJ_CINEMA2K_24 + self._cparams.cp_cinema = core.OPJ_CINEMA2K_24 else: - cparams.cp_cinema = core.OPJ_CINEMA2K_48 + self._cparams.cp_cinema = core.OPJ_CINEMA2K_48 else: # 2.1 API if fps == 24: - cparams.rsiz = core.OPJ_PROFILE_CINEMA_2K - cparams.max_comp_size = core.OPJ_CINEMA_24_COMP - cparams.max_cs_size = core.OPJ_CINEMA_24_CS + self._cparams.rsiz = core.OPJ_PROFILE_CINEMA_2K + self._cparams.max_comp_size = core.OPJ_CINEMA_24_COMP + self._cparams.max_cs_size = core.OPJ_CINEMA_24_CS else: - cparams.rsiz = core.OPJ_PROFILE_CINEMA_2K - cparams.max_comp_size = core.OPJ_CINEMA_48_COMP - cparams.max_cs_size = core.OPJ_CINEMA_48_CS + self._cparams.rsiz = core.OPJ_PROFILE_CINEMA_2K + self._cparams.max_comp_size = core.OPJ_CINEMA_48_COMP + self._cparams.max_cs_size = core.OPJ_CINEMA_48_CS else: # cinema4k if re.match("2.0", version.openjpeg_version) is not None: # 2.0 API - cparams.cp_cinema = core.OPJ_CINEMA4K_24 + self._cparams.cp_cinema = core.OPJ_CINEMA4K_24 else: # 2.1 API - cparams.rsiz = core.OPJ_PROFILE_CINEMA_4K + self._cparams.rsiz = core.OPJ_PROFILE_CINEMA_4K - return - - def _populate_cparams(self, **kwargs): - """Populate compression parameters structure from input arguments. + def _populate_cparams(self, img_array, **kwargs): + """Directs processing of write method arguments. Parameters ---------- - cbsize : tuple, optional - Code block size (DY, DX). - cratios : iterable - Compression ratios for successive layers. - eph : bool, optional - If true, write SOP marker after each header packet. - grid_offset : tuple, optional - Offset (DY, DX) of the origin of the image in the reference grid. - mct : bool, optional - Specifies usage of the multi component transform. If not - specified, defaults to True if the colorspace is RGB. - modesw : int, optional - Mode switch. - 1 = BYPASS(LAZY) - 2 = RESET - 4 = RESTART(TERMALL) - 8 = VSC - 16 = ERTERM(SEGTERM) - 32 = SEGMARK(SEGSYM) - numres : int, optional - Number of resolutions. - prog : str, optional - Progression order, one of "LRCP" "RLCP", "RPCL", "PCRL", "CPRL". - psnr : iterable, optional - Different PSNR for successive layers. - psizes : list, optional - List of precinct sizes. Each precinct size tuple is defined in - (height x width). - sop : bool, optional - If true, write SOP marker before each packet. - subsam : tuple, optional - Subsampling factors (dy, dx). - tilesize : tuple, optional - Numeric tuple specifying tile size in terms of (numrows, numcols), - not (X, Y). - - Returns - ------- - cparams : CompressionParametersType(ctypes.Structure) - Corresponds to cparameters_t type in openjp2 headers. + img_array : ndarray + image data to be written to file + kwargs : dictionary + non-image keyword inputs provided to write method """ + if ((('cinema2k' in kwargs or 'cinema4k' in kwargs) and + (len(set(kwargs)) > 1))): + msg = "Cannot specify cinema2k/cinema4k along with other options." + raise IOError(msg) + + if 'cratios' in kwargs and 'psnr' in kwargs: + msg = "Cannot specify cratios and psnr together." + raise IOError(msg) + if version.openjpeg_version_tuple[0] == 1: cparams = opj.set_default_encoder_parameters() else: @@ -275,12 +406,14 @@ class Jp2k(Jp2kBox): cparams.irreversible = 1 if 'cinema2k' in kwargs: - self._set_cinema_params(cparams, 'cinema2k', kwargs['cinema2k']) - return cparams + self._cparams = cparams + self._set_cinema_params('cinema2k', kwargs['cinema2k']) + return if 'cinema4k' in kwargs: - self._set_cinema_params(cparams, 'cinema4k', kwargs['cinema4k']) - return cparams + self._cparams = cparams + self._set_cinema_params('cinema4k', kwargs['cinema4k']) + return if 'cbsize' in kwargs: cparams.cblockw_init = kwargs['cbsize'][1] @@ -310,7 +443,7 @@ class Jp2k(Jp2kBox): if 'prog' in kwargs: prog = kwargs['prog'].upper() - cparams.prog_order = PROGRESSION_ORDER[prog] + cparams.prog_order = core.PROGRESSION_ORDER[prog] if 'psnr' in kwargs: cparams.tcp_numlayers = len(kwargs['psnr']) @@ -337,49 +470,9 @@ class Jp2k(Jp2kBox): cparams.cp_tdy = kwargs['tilesize'][0] cparams.tile_size_on = opj2.TRUE - return cparams - - def _process_write_inputs(self, img_array, colorspace=None, **kwargs): - """Directs processing of write method arguments. - - It's somewhat awkward to process all the kwargs arguments at once. - The "colorspace" is not a parameter that gets processed into the - compression parameters structure, and it unfortunately must be handled - in the middle of the compression parameter processing. - - Parameters - ---------- - img_array : ndarray - Image data to be written to file. - colorspace : str, optional - Either 'rgb' or 'gray'. - - Returns - ------- - cparams : CompressionParametersType(ctypes.Structure) - Corresponds to cparameters_t type in openjp2 headers. - colorspace : int - Either CLRSPC_SRGB or CLRSPC_GRAY - """ - if (('cinema2k' in kwargs or 'cinema4k' in kwargs) and - (len(set(kwargs)) > 1)): - msg = "Cannot specify cinema2k/cinema4k along with other options." - raise IOError(msg) - - if 'cratios' in kwargs and 'psnr' in kwargs: - msg = "Cannot specify cratios and psnr together." - raise IOError(msg) - - cparams = self._populate_cparams(**kwargs) - _validate_compression_params(img_array, cparams) - - colorspace = _unpack_colorspace(colorspace, img_array, cparams) - try: mct = kwargs['mct'] - if mct and colorspace == opj2.CLRSPC_GRAY: - # Cannot check for this in the validate routine, as we need - # to know what the target colorspace has been determined to be. + if mct and self._colorspace == opj2.CLRSPC_GRAY: msg = "Cannot specify usage of the multi component transform " msg += "if the colorspace is gray." raise IOError(msg) @@ -387,122 +480,62 @@ class Jp2k(Jp2kBox): except KeyError: # If the multi component transform was not specified, we infer # that it should be used if the color space is RGB. - if colorspace == opj2.CLRSPC_SRGB: + if self._colorspace == opj2.CLRSPC_SRGB: cparams.tcp_mct = 1 else: cparams.tcp_mct = 0 - return cparams, colorspace + self._validate_compression_params(img_array, cparams, **kwargs) - def write(self, img_array, verbose=False, **kwargs): + self._cparams = cparams + + def _write(self, img_array, verbose=False, **kwargs): """Write image data to a JP2/JPX/J2k file. Intended usage of the various parameters follows that of OpenJPEG's opj_compress utility. This method can only be used to create JPEG 2000 images that can fit in memory. - - Parameters - ---------- - img_array : ndarray - Image data to be written to file. - cbsize : tuple, optional - Code block size (DY, DX). - cinema2k : int, optional - frames per second, either 24 or 48 - cinema4k : bool, optional - Set to True to specify Cinema4K mode, defaults to false. - colorspace : str, optional - Either 'rgb' or 'gray'. - cratios : iterable - Compression ratios for successive layers. - eph : bool, optional - If true, write SOP marker after each header packet. - grid_offset : tuple, optional - Offset (DY, DX) of the origin of the image in the reference grid. - irreversible : bool, optional - If true, use the irreversible DWT 9-7 transform. - mct : bool, optional - Specifies usage of the multi component transform. If not - specified, defaults to True if the colorspace is RGB. - modesw : int, optional - Mode switch. - 1 = BYPASS(LAZY) - 2 = RESET - 4 = RESTART(TERMALL) - 8 = VSC - 16 = ERTERM(SEGTERM) - 32 = SEGMARK(SEGSYM) - numres : int, optional - Number of resolutions. - prog : str, optional - Progression order, one of "LRCP" "RLCP", "RPCL", "PCRL", "CPRL". - psnr : iterable, optional - Different PSNR for successive layers. - psizes : list, optional - List of precinct sizes. Each precinct size tuple is defined in - (height x width). - sop : bool, optional - If true, write SOP marker before each packet. - subsam : tuple, optional - Subsampling factors (dy, dx). - tilesize : tuple, optional - Numeric tuple specifying tile size in terms of (numrows, numcols), - not (X, Y). - verbose : bool, optional - Print informational messages produced by the OpenJPEG library. - - Examples - -------- - >>> import glymur - >>> jfile = glymur.data.nemo() - >>> jp2 = glymur.Jp2k(jfile) - >>> data = jp2.read(rlevel=1) - >>> from tempfile import NamedTemporaryFile - >>> tfile = NamedTemporaryFile(suffix='.jp2', delete=False) - >>> j = Jp2k(tfile.name, mode='wb') - >>> j.write(data.astype(np.uint8)) - - Raises - ------ - glymur.LibraryNotFoundError - If glymur is unable to load the openjp2 library. """ - if opj2.OPENJP2 is not None: - self._write_openjp2(img_array, verbose=verbose, **kwargs) - elif opj.OPENJPEG is not None: - self._write_openjpeg(img_array, verbose=verbose, **kwargs) - else: - raise LibraryNotFoundError("You must have at least version 1.5 of " - "OpenJPEG before using this " - "functionality.") + if re.match("0|1.[0-4]", version.openjpeg_version) is not None: + msg = "You must have at least version 1.5 of OpenJPEG " + msg += "in order to write images." + raise RuntimeError(msg) - def _write_openjpeg(self, img_array, verbose=False, **kwargs): + self._determine_colorspace(**kwargs) + self._populate_cparams(img_array, **kwargs) + + if opj2.OPENJP2 is not None: + self._write_openjp2(img_array, verbose=verbose) + else: + self._write_openjpeg(img_array, verbose=verbose) + + def _write_openjpeg(self, img_array, verbose=False): """ Write JPEG 2000 file using OpenJPEG 1.5 interface. """ - cparams, colorspace = self._process_write_inputs(img_array, **kwargs) - if img_array.ndim == 2: # Force the image to be 3D. Just makes things easier later on. img_array = img_array.reshape(img_array.shape[0], img_array.shape[1], 1) - comptparms = _populate_comptparms(img_array, cparams) + self._populate_comptparms(img_array) with ExitStack() as stack: - image = opj.image_create(comptparms, colorspace) + image = opj.image_create(self._comptparms, self._colorspace) stack.callback(opj.image_destroy, image) numrows, numcols, numlayers = img_array.shape # set image offset and reference grid - image.contents.x0 = cparams.image_offset_x0 - image.contents.y0 = cparams.image_offset_y0 - image.contents.x1 = image.contents.x0 \ - + (numcols - 1) * cparams.subsampling_dx + 1 - image.contents.y1 = image.contents.y0 \ - + (numrows - 1) * cparams.subsampling_dy + 1 + image.contents.x0 = self._cparams.image_offset_x0 + image.contents.y0 = self._cparams.image_offset_y0 + image.contents.x1 = (image.contents.x0 + + (numcols - 1) * self._cparams.subsampling_dx + + 1) + image.contents.y1 = (image.contents.y0 + + (numrows - 1) * self._cparams.subsampling_dy + + 1) # Stage the image data to the openjpeg data structure. for k in range(0, numlayers): @@ -512,7 +545,7 @@ class Jp2k(Jp2kBox): src = layer.ctypes.data ctypes.memmove(dest, src, layer.nbytes) - cinfo = opj.create_compress(cparams.codec_fmt) + cinfo = opj.create_compress(self._cparams.codec_fmt) stack.callback(opj.destroy_compress, cinfo) # Setup the info, warning, and error handlers. @@ -526,7 +559,7 @@ class Jp2k(Jp2kBox): event_mgr.error_handler = ctypes.cast(_ERROR_CALLBACK, ctypes.c_void_p) - opj.setup_encoder(cinfo, ctypes.byref(cparams), image) + opj.setup_encoder(cinfo, ctypes.byref(self._cparams), image) cio = opj.cio_open(cinfo) stack.callback(opj.cio_close, cio) @@ -543,35 +576,143 @@ class Jp2k(Jp2kBox): self.parse() + def _validate_compression_params(self, img_array, cparams, **kwargs): + """Check that the compression parameters are valid. - def _write_openjp2(self, img_array, verbose=False, **kwargs): + Parameters + ---------- + img_array : ndarray + Image data to be written to file. + cparams : CompressionParametersType(ctypes.Structure) + Corresponds to cparameters_t type in openjp2 headers. """ - Write JPEG 2000 file using OpenJPEG 2.0 interface. - """ - cparams, colorspace = self._process_write_inputs(img_array, **kwargs) + # Cannot specify a colorspace with J2K. + if cparams.codec_fmt == opj2.CODEC_J2K and 'colorspace' in kwargs: + msg = 'Do not specify a colorspace when writing a raw ' + msg += 'codestream.' + raise IOError(msg) + # Code block size + code_block_specified = False + if cparams.cblockw_init != 0 and cparams.cblockh_init != 0: + # These fields ARE zero if uninitialized. + width = cparams.cblockw_init + height = cparams.cblockh_init + code_block_specified = True + if height * width > 4096 or height < 4 or width < 4: + msg = "Code block area cannot exceed 4096. " + msg += "Code block height and width must be larger than 4." + raise IOError(msg) + if ((math.log(height, 2) != math.floor(math.log(height, 2)) or + math.log(width, 2) != math.floor(math.log(width, 2)))): + msg = "Bad code block size ({0}, {1}), " + msg += "must be powers of 2." + raise IOError(msg.format(height, width)) + + # Precinct size + if cparams.res_spec != 0: + # precinct size was not specified if this field is zero. + for j in range(cparams.res_spec): + prch = cparams.prch_init[j] + prcw = cparams.prcw_init[j] + if j == 0 and code_block_specified: + height, width = cparams.cblockh_init, cparams.cblockw_init + if height * 2 > prch or width * 2 > prcw: + msg = "Highest Resolution precinct size must be at " + msg += "least twice that of the code block dimensions." + raise IOError(msg) + if ((math.log(prch, 2) != math.floor(math.log(prch, 2)) or + math.log(prcw, 2) != math.floor(math.log(prcw, 2)))): + msg = "Bad precinct sizes ({0}, {1}), " + msg += "must be powers of 2." + raise IOError(msg.format(prch, prcw)) + + # What would the point of 1D images be? + if img_array.ndim == 1 or img_array.ndim > 3: + msg = "{0}D imagery is not allowed.".format(img_array.ndim) + raise IOError(msg) + + if re.match("2.0.0", version.openjpeg_version) is not None: + if (((img_array.ndim != 2) and + (img_array.shape[2] != 1 and img_array.shape[2] != 3))): + msg = "Writing images is restricted to single-channel " + msg += "greyscale images or three-channel RGB images when " + msg += "the OpenJPEG library version is the official 2.0.0 " + msg += "release." + raise IOError(msg) + + if img_array.dtype != np.uint8 and img_array.dtype != np.uint16: + msg = "Only uint8 and uint16 datatypes are currently supported " + msg += "when writing." + raise RuntimeError(msg) + + def _determine_colorspace(self, colorspace=None, **kwargs): + """Determine the colorspace from the supplied inputs. + + Parameters + ---------- + colorspace : str, optional + Either 'rgb' or 'gray'. + """ + if colorspace is None: + # Must infer the colorspace from the image dimensions. + if len(self.shape) < 3: + # A single channel image is grayscale. + self._colorspace = opj2.CLRSPC_GRAY + elif self.shape[2] == 1 or self.shape[2] == 2: + # A single channel image or an image with two channels is going + # to be greyscale. + self._colorspace = opj2.CLRSPC_GRAY + else: + # Anything else must be RGB, right? + self._colorspace = opj2.CLRSPC_SRGB + else: + if colorspace.lower() not in ('rgb', 'grey', 'gray'): + msg = 'Invalid colorspace "{0}"'.format(colorspace) + raise IOError(msg) + elif colorspace.lower() == 'rgb' and self.shape[2] < 3: + msg = 'RGB colorspace requires at least 3 components.' + raise IOError(msg) + + # Turn the colorspace from a string to the enumerated value that + # the library expects. + COLORSPACE_MAP = {'rgb': opj2.CLRSPC_SRGB, + 'gray': opj2.CLRSPC_GRAY, + 'grey': opj2.CLRSPC_GRAY, + 'ycc': opj2.CLRSPC_YCC} + + self._colorspace = COLORSPACE_MAP[colorspace.lower()] + + def _write_openjp2(self, img_array, verbose=False): + """ + Write JPEG 2000 file using OpenJPEG 2.x interface. + """ if img_array.ndim == 2: # Force the image to be 3D. Just makes things easier later on. numrows, numcols = img_array.shape img_array = img_array.reshape(numrows, numcols, 1) - comptparms = _populate_comptparms(img_array, cparams) + self._populate_comptparms(img_array) with ExitStack() as stack: - image = opj2.image_create(comptparms, colorspace) + image = opj2.image_create(self._comptparms, self._colorspace) stack.callback(opj2.image_destroy, image) - _populate_image_struct(cparams, image, img_array) + self._populate_image_struct(image, img_array) - codec = opj2.create_compress(cparams.codec_fmt) + codec = opj2.create_compress(self._cparams.codec_fmt) stack.callback(opj2.destroy_codec, codec) - info_handler = _INFO_CALLBACK if verbose else None + if self._verbose or verbose: + info_handler = _INFO_CALLBACK + else: + info_handler = None + opj2.set_info_handler(codec, info_handler) opj2.set_warning_handler(codec, _WARNING_CALLBACK) opj2.set_error_handler(codec, _ERROR_CALLBACK) - opj2.setup_encoder(codec, cparams, image) + opj2.setup_encoder(codec, self._cparams, image) if re.match("2.0", version.openjpeg_version) is not None: fptr = libc.fopen(self.filename, 'wb') @@ -607,7 +748,8 @@ class Jp2k(Jp2kBox): if not ((box.box_id == 'xml ') or (box.box_id == 'uuid' and box.uuid == UUID('be7acfcb-97a9-42e8-9c71-999491e3afac'))): - msg = "Only XML boxes and XMP UUID boxes can currently be appended." + msg = "Only XML boxes and XMP UUID boxes can currently be " + msg += "appended." raise IOError(msg) # Check the last box. If the length field is zero, then rewrite @@ -703,7 +845,7 @@ class Jp2k(Jp2kBox): raise IOError(msg) # Find the first codestream in the file. - jp2c = [box for box in self.box if box.box_id == 'jp2c'] + jp2c = [_box for _box in self.box if _box.box_id == 'jp2c'] offset = jp2c[0].offset # Ready to write the codestream. @@ -737,16 +879,15 @@ class Jp2k(Jp2kBox): FileTypeBox(), JP2HeaderBox(), ContiguousCodestreamBox()] - codestream = self.get_codestream() - height = codestream.segment[1].ysiz - width = codestream.segment[1].xsiz - num_components = len(codestream.segment[1].xrsiz) + height = self.codestream.segment[1].ysiz + width = self.codestream.segment[1].xsiz + num_components = len(self.codestream.segment[1].xrsiz) if num_components < 3: - colorspace = GREYSCALE + colorspace = core.GREYSCALE else: if len(self.box) == 0: # Best guess is SRGB - colorspace = SRGB + colorspace = core.SRGB else: # Take whatever the first jp2 header / color specification # says. @@ -759,27 +900,132 @@ class Jp2k(Jp2kBox): return boxes - def read(self, **kwargs): - """Read a JPEG 2000 image. + def __setitem__(self, index, data): + """ + Slicing protocol. + """ + if ((isinstance(index, slice) and + (index.start is None and + index.stop is None and + index.step is None)) or (index is Ellipsis)): + # Case of jp2[:] = data, i.e. write the entire image. + # + # Should have a slice object where start = stop = step = None + self._write(data) + else: + msg = "Partial write operations are currently not allowed." + raise TypeError(msg) - Parameters - ---------- - rlevel : int, optional - Factor by which to rlevel output resolution. Use -1 to get the - lowest resolution thumbnail. This is the only keyword option - available to use when only the OpenJPEG version 1.5.1 is present. - layer : int, optional - Number of quality layer to decode. - area : tuple, optional - Specifies decoding image area, - (first_row, first_col, last_row, last_col) - tile : int, optional - Number of tile to decode. - ignore_pclr_cmap_cdef : bool - Whether or not to ignore the pclr, cmap, or cdef boxes during any - color transformation. Defaults to False. - verbose : bool, optional - Print informational messages produced by the OpenJPEG library. + def __getitem__(self, pargs): + """ + Slicing protocol. + """ + if len(self.shape) == 2: + numrows, numcols = self.shape + numbands = 1 + else: + numrows, numcols, numbands = self.shape + + if isinstance(pargs, int): + # Not a very good use of this protocol, but technically legal. + # This retrieves a single row. + row = pargs + area = (row, 0, row + 1, numcols) + return self._read(area=area).squeeze() + + if pargs is Ellipsis: + # Case of jp2[...] + return self._read() + + if isinstance(pargs, slice): + if (((pargs.start is None) and + (pargs.stop is None) and + (pargs.step is None))): + # Case of jp2[:] + return self._read() + + # Corner case of jp2[x] where x is a slice object with non-null + # members. Just augment it with an ellipsis and let the code + # below handle it. + pargs = (pargs, Ellipsis) + + if isinstance(pargs, tuple) and any(x is Ellipsis for x in pargs): + # Remove the first ellipsis we find. + rows = slice(0, numrows) + cols = slice(0, numcols) + bands = slice(0, numbands) + if pargs[0] is Ellipsis: + if len(pargs) == 2: + newindex = (rows, cols, pargs[1]) + else: + newindex = (rows, pargs[1], pargs[2]) + elif pargs[1] is Ellipsis: + if len(pargs) == 2: + newindex = (pargs[0], cols, bands) + else: + newindex = (pargs[0], cols, pargs[2]) + else: + # Assume that we don't have 4D imagery, of course. + newindex = (pargs[0], pargs[1], bands) + + # Run once again because it is possible that there's another + # Ellipsis object in the 2nd or 3rd position. + return self.__getitem__(newindex) + + if isinstance(pargs, tuple) and any(isinstance(x, int) for x in pargs): + # Replace the first such integer argument, replace it with a slice. + lst = list(pargs) + predicate = lambda x: not isinstance(x[1], int) + g = filterfalse(predicate, enumerate(pargs)) + idx = next(g)[0] + lst[idx] = slice(pargs[idx], pargs[idx] + 1) + newindex = tuple(lst) + + # Invoke array-based slicing again, as there may be additional + # integer argument remaining. + data = self.__getitem__(newindex) + + # Reduce dimensionality in the scalar dimension. + return np.squeeze(data, axis=idx) + + # Assuming pargs is a tuple of slices from now on. + rows = pargs[0] + cols = pargs[1] + if len(pargs) == 2: + bands = slice(None, None, None) + else: + bands = pargs[2] + + rows_step = 1 if rows.step is None else rows.step + cols_step = 1 if cols.step is None else cols.step + if rows_step != cols_step: + msg = "Row and column strides must be the same." + raise IndexError(msg) + + # Ok, reduce layer step is the same in both xy directions, so just take + # one of them. + step = rows_step + + # Check if the step size is a power of 2. + if np.abs(np.log2(step) - np.round(np.log2(step))) > 1e-6: + msg = "Row and column strides must be powers of 2." + raise IndexError(msg) + rlevel = np.int(np.round(np.log2(step))) + + area = (0 if rows.start is None else rows.start, + 0 if cols.start is None else cols.start, + numrows if rows.stop is None else rows.stop, + numcols if cols.stop is None else cols.stop + ) + data = self._read(area=area, rlevel=rlevel) + if len(pargs) == 2: + return data + + # Ok, 3 arguments in pargs. + return data[:, :, bands] + + def _read(self, **kwargs): + """Read a JPEG 2000 image. Returns ------- @@ -788,52 +1034,67 @@ class Jp2k(Jp2kBox): Raises ------ - glymur.LibraryNotFoundError - If glymur is unable to load either the openjpeg or openjp2 - libraries. IOError If the image has differing subsample factors. - - Examples - -------- - >>> import glymur - >>> jfile = glymur.data.nemo() - >>> jp = glymur.Jp2k(jfile) - >>> image = jp.read() - >>> image.shape - (1456, 2592, 3) - - Read the lowest resolution thumbnail. - - >>> thumbnail = jp.read(rlevel=-1) - >>> thumbnail.shape - (728, 1296, 3) """ - if opj2.OPENJP2 is not None: - img = self._read_openjp2(**kwargs) - elif opj.OPENJPEG is not None: + if version.openjpeg_version_tuple[0] < 2: img = self._read_openjpeg(**kwargs) else: - raise LibraryNotFoundError("You must have either a recent version " - "of OpenJPEG or the development " - "version of OpenJP2 installed before " - "using this functionality.") + img = self._read_openjp2(**kwargs) + return img + + def read(self, **kwargs): + """ + """ + # Read a JPEG 2000 image. + # + # Parameters + # ---------- + # rlevel : int, optional + # Factor by which to rlevel output resolution. Use -1 to get the + # lowest resolution thumbnail. This is the only keyword option + # available to use when the OpenJPEG version is 1.5 or earlier. + # layer : int, optional + # Number of quality layer to decode. + # area : tuple, optional + # Specifies decoding image area, + # (first_row, first_col, last_row, last_col) + # tile : int, optional + # Number of tile to decode. + # verbose : bool, optional + # Print informational messages produced by the OpenJPEG library. + # + # Returns + # ------- + # img_array : ndarray + # The image data. + # + # Raises + # ------ + # IOError + # If the image has differing subsample factors. + + if 'ignore_pclr_cmap_cdef' in kwargs: + self.ignore_pclr_cmap_cdef = kwargs['ignore_pclr_cmap_cdef'] + warnings.warn("Use array-style slicing instead.", DeprecationWarning) + if version.openjpeg_version_tuple[0] < 2: + img = self._read_openjpeg(**kwargs) + else: + img = self._read_openjp2(**kwargs) return img def _subsampling_sanity_check(self): """Check for differing subsample factors. """ - codestream = self.get_codestream(header_only=True) - dxs = np.array(codestream.segment[1].xrsiz) - dys = np.array(codestream.segment[1].yrsiz) + dxs = np.array(self.codestream.segment[1].xrsiz) + dys = np.array(self.codestream.segment[1].yrsiz) if np.any(dxs - dxs[0]) or np.any(dys - dys[0]): msg = "Components must all have the same subsampling factors " msg += "to use this method. Please consider using OPENJP2 and " msg += "the read_bands method instead." raise RuntimeError(msg) - def _read_openjpeg(self, rlevel=0, ignore_pclr_cmap_cdef=False, - verbose=False): + def _read_openjpeg(self, rlevel=0, verbose=False, area=None): """Read a JPEG 2000 image using libopenjpeg. Parameters @@ -841,11 +1102,11 @@ class Jp2k(Jp2kBox): rlevel : int, optional Factor by which to rlevel output resolution. Use -1 to get the lowest resolution thumbnail. - ignore_pclr_cmap_cdef : bool - Whether or not to ignore the pclr, cmap, or cdef boxes during any - color transformation. Defaults to False. verbose : bool, optional Print informational messages produced by the OpenJPEG library. + area : tuple, optional + Specifies decoding image area, + (first_row, first_col, last_row, last_col) Returns ------- @@ -859,24 +1120,27 @@ class Jp2k(Jp2kBox): """ self._subsampling_sanity_check() - dparameters = self._populate_dparam(rlevel, ignore_pclr_cmap_cdef) + self._populate_dparams(rlevel) with ExitStack() as stack: try: - dparameters.decod_format = self._codec_format + self._dparams.decod_format = self._codec_format - dinfo = opj.create_decompress(dparameters.decod_format) + dinfo = opj.create_decompress(self._dparams.decod_format) event_mgr = opj.EventMgrType() info_handler = ctypes.cast(_INFO_CALLBACK, ctypes.c_void_p) - event_mgr.info_handler = info_handler if verbose else None + if verbose or self._verbose: + event_mgr.info_handler = info_handler + else: + event_mgr.info_handler = None event_mgr.warning_handler = ctypes.cast(_WARNING_CALLBACK, ctypes.c_void_p) event_mgr.error_handler = ctypes.cast(_ERROR_CALLBACK, ctypes.c_void_p) opj.set_event_mgr(dinfo, ctypes.byref(event_mgr)) - opj.setup_decoder(dinfo, dparameters) + opj.setup_decoder(dinfo, self._dparams) with open(self.filename, 'rb') as fptr: src = fptr.read() @@ -898,10 +1162,22 @@ class Jp2k(Jp2kBox): # data 2D instead of 3D. data.shape = data.shape[0:2] + if area is not None: + x0, y0, x1, y1 = area + extent = 2 ** rlevel + if x1 - x0 < extent or y1 - y0 < extent: + msg = "Decoded area is too small." + raise IOError(msg) + + area = [int(round(float(x)/extent + 2 ** -20)) for x in area] + rows = slice(area[0], area[2], None) + cols = slice(area[1], area[3], None) + data = data[rows, cols] + return data - def _read_openjp2(self, rlevel=0, layer=0, area=None, tile=None, - verbose=False, ignore_pclr_cmap_cdef=False): + def _read_openjp2(self, rlevel=0, layer=None, area=None, tile=None, + verbose=False): """Read a JPEG 2000 image using libopenjp2. Parameters @@ -929,10 +1205,12 @@ class Jp2k(Jp2kBox): RuntimeError If the image has differing subsample factors. """ + if layer is not None: + self._layer = layer + self._subsampling_sanity_check() - dparam = self._populate_dparam(rlevel, ignore_pclr_cmap_cdef, - layer=layer, tile=tile, area=area) + self._populate_dparams(rlevel, tile=tile, area=area) with ExitStack() as stack: if re.match("2.1", version.openjpeg_version): @@ -949,23 +1227,26 @@ class Jp2k(Jp2kBox): opj2.set_error_handler(codec, _ERROR_CALLBACK) opj2.set_warning_handler(codec, _WARNING_CALLBACK) - if verbose: + + if self._verbose or verbose: opj2.set_info_handler(codec, _INFO_CALLBACK) else: opj2.set_info_handler(codec, None) - opj2.setup_decoder(codec, dparam) + opj2.setup_decoder(codec, self._dparams) image = opj2.read_header(stream, codec) stack.callback(opj2.image_destroy, image) - if dparam.nb_tile_to_decode: - opj2.get_decoded_tile(codec, stream, image, dparam.tile_index) + if self._dparams.nb_tile_to_decode: + opj2.get_decoded_tile(codec, stream, image, + self._dparams.tile_index) else: opj2.set_decode_area(codec, image, - dparam.DA_x0, dparam.DA_y0, - dparam.DA_x1, dparam.DA_y1) + self._dparams.DA_x0, self._dparams.DA_y0, + self._dparams.DA_x1, self._dparams.DA_y1) opj2.decode(codec, stream, image) - opj2.end_decompress(codec, stream) + + opj2.end_decompress(codec, stream) img_array = extract_image_cube(image) @@ -974,14 +1255,11 @@ class Jp2k(Jp2kBox): return img_array - def _populate_dparam(self, rlevel, ignore_pclr_cmap_cdef, tile=None, - layer=None, area=None): + def _populate_dparams(self, rlevel, tile=None, area=None): """Populate decompression structure with appropriate input parameters. Parameters ---------- - layer : int - Number of quality layer to decode. rlevel : int Factor by which to rlevel output resolution. area : tuple @@ -989,14 +1267,6 @@ class Jp2k(Jp2kBox): (first_row, first_col, last_row, last_col) tile : int Number of tile to decode. - ignore_pclr_cmap_cdef : bool - Whether or not to ignore the pclr, cmap, or cdef boxes during any - color transformation. Defaults to False. - - Returns - ------- - dparam : DecompressionParametersType (ctypes) - Corresponds to openjp2 decompression parameters structure. """ if opj2.OPENJP2 is not None: dparam = opj2.set_default_decoder_parameters() @@ -1009,16 +1279,18 @@ class Jp2k(Jp2kBox): infile += b'0' * nelts dparam.infile = infile + if self.ignore_pclr_cmap_cdef: + # Return raw codestream components. + dparam.flags |= 1 + dparam.decod_format = self._codec_format - if layer is not None: - dparam.cp_layer = layer + dparam.cp_layer = self._layer # Must check the specified rlevel against the maximum. if rlevel != 0: # Must check the specified rlevel against the maximum. - codestream = self.get_codestream() - max_rlevel = codestream.segment[2].spcod[4] + max_rlevel = self.codestream.segment[2].spcod[4] if rlevel == -1: # -1 is shorthand for the largest rlevel rlevel = max_rlevel @@ -1043,13 +1315,13 @@ class Jp2k(Jp2kBox): dparam.tile_index = tile dparam.nb_tile_to_decode = 1 - if ignore_pclr_cmap_cdef is True: + if self.ignore_pclr_cmap_cdef: # Return raw codestream components. dparam.flags |= 1 - return dparam + self._dparams = dparam - def read_bands(self, rlevel=0, layer=0, area=None, tile=None, + def read_bands(self, rlevel=0, layer=None, area=None, tile=None, verbose=False, ignore_pclr_cmap_cdef=False): """Read a JPEG 2000 image. @@ -1089,19 +1361,16 @@ class Jp2k(Jp2kBox): >>> jfile = glymur.data.nemo() >>> jp = glymur.Jp2k(jfile) >>> components_lst = jp.read_bands(rlevel=1) - - Raises - ------ - glymur.LibraryNotFoundError - If glymur is unable to load the openjp2 library. """ if version.openjpeg_version_tuple[0] < 2: - raise LibraryNotFoundError("You must have at least version 2.0.0 " - "of OpenJP2 installed before using " - "this functionality.") + raise RuntimeError("You must have at least version 2.0.0 of " + "OpenJPEG installed before using this " + "functionality.") - dparam = self._populate_dparam(rlevel, ignore_pclr_cmap_cdef, - layer=layer, tile=tile, area=area) + self.ignore_pclr_cmap_cdef = ignore_pclr_cmap_cdef + if layer is not None: + self._layer = layer + self._populate_dparams(rlevel, tile=tile, area=area) with ExitStack() as stack: if re.match("2.1", version.openjpeg_version): @@ -1124,16 +1393,17 @@ class Jp2k(Jp2kBox): else: opj2.set_info_handler(codec, None) - opj2.setup_decoder(codec, dparam) + opj2.setup_decoder(codec, self._dparams) image = opj2.read_header(stream, codec) stack.callback(opj2.image_destroy, image) - if dparam.nb_tile_to_decode: - opj2.get_decoded_tile(codec, stream, image, dparam.tile_index) + if self._dparams.nb_tile_to_decode: + opj2.get_decoded_tile(codec, stream, image, + self._dparams.tile_index) else: opj2.set_decode_area(codec, image, - dparam.DA_x0, dparam.DA_y0, - dparam.DA_x1, dparam.DA_y1) + self._dparams.DA_x0, self._dparams.DA_y0, + self._dparams.DA_x1, self._dparams.DA_y1) opj2.decode(codec, stream, image) opj2.end_decompress(codec, stream) @@ -1176,7 +1446,6 @@ class Jp2k(Jp2kBox): codestream = Codestream(fptr, self.length, header_only=header_only) else: - ftyp = self.box[1] box = [x for x in self.box if x.box_id == 'jp2c'] fptr.seek(box[0].offset) read_buffer = fptr.read(8) @@ -1194,6 +1463,82 @@ class Jp2k(Jp2kBox): return codestream + def _populate_image_struct(self, image, imgdata): + """Populates image struct needed for compression. + + Parameters + ---------- + image : ImageType(ctypes.Structure) + Corresponds to image_t type in openjp2 headers. + img_array : ndarray + Image data to be written to file. + """ + + numrows, numcols, num_comps = imgdata.shape + + # set image offset and reference grid + image.contents.x0 = self._cparams.image_offset_x0 + image.contents.y0 = self._cparams.image_offset_y0 + image.contents.x1 = (image.contents.x0 + + (numcols - 1) * self._cparams.subsampling_dx + 1) + image.contents.y1 = (image.contents.y0 + + (numrows - 1) * self._cparams.subsampling_dy + 1) + + # Stage the image data to the openjpeg data structure. + for k in range(0, num_comps): + if re.match("2.0", version.openjpeg_version) is not None: + # 2.0 API + if self._cparams.cp_cinema: + image.contents.comps[k].prec = 12 + image.contents.comps[k].bpp = 12 + else: + # 2.1 API + if self._cparams.rsiz in (core.OPJ_PROFILE_CINEMA_2K, + core.OPJ_PROFILE_CINEMA_4K): + image.contents.comps[k].prec = 12 + image.contents.comps[k].bpp = 12 + + layer = np.ascontiguousarray(imgdata[:, :, k], dtype=np.int32) + dest = image.contents.comps[k].data + src = layer.ctypes.data + ctypes.memmove(dest, src, layer.nbytes) + + return image + + def _populate_comptparms(self, img_array): + """Instantiate and populate comptparms structure. + + This structure defines the image components. + + Parameters + ---------- + img_array : ndarray + Image data to be written to file. + """ + # Only two precisions are possible. + if img_array.dtype == np.uint8: + comp_prec = 8 + else: + comp_prec = 16 + + numrows, numcols, num_comps = img_array.shape + if version.openjpeg_version_tuple[0] == 1: + comptparms = (opj.ImageComptParmType * num_comps)() + else: + comptparms = (opj2.ImageComptParmType * num_comps)() + for j in range(num_comps): + comptparms[j].dx = self._cparams.subsampling_dx + comptparms[j].dy = self._cparams.subsampling_dy + comptparms[j].w = numcols + comptparms[j].h = numrows + comptparms[j].x0 = self._cparams.image_offset_x0 + comptparms[j].y0 = self._cparams.image_offset_y0 + comptparms[j].prec = comp_prec + comptparms[j].bpp = comp_prec + comptparms[j].sgnd = 0 + + self._comptparms = comptparms + def _component2dtype(component): """Take an OpenJPEG component structure and determine the numpy datatype. @@ -1240,6 +1585,7 @@ JP2_IDS = ['colr', 'cdef', 'cmap', 'jp2c', 'ftyp', 'ihdr', 'jp2h', 'jP ', 'pclr', 'res ', 'resc', 'resd', 'xml ', 'ulst', 'uinf', 'url ', 'uuid'] + def _validate_jp2_box_sequence(boxes): """Run through series of tests for JP2 box legality. @@ -1255,12 +1601,13 @@ def _validate_jp2_box_sequence(boxes): count = _collect_box_count(boxes) for box_id in count.keys(): if box_id not in JP2_IDS: - msg = "The presence of a '{0}' box requires that the file type " - msg += "brand be set to 'jpx '." + msg = "The presence of a '{0}' box requires that the file " + msg += "type brand be set to 'jpx '." raise IOError(msg.format(box_id)) _validate_jp2_colr(boxes) + def _validate_jp2_colr(boxes): """ Validate JP2 requirements on colour specification boxes. @@ -1272,6 +1619,7 @@ def _validate_jp2_colr(boxes): msg = "A JP2 colr box cannot have a non-zero approximation field." raise IOError(msg) + def _validate_jpx_box_sequence(boxes): """Run through series of tests for JPX box legality.""" _validate_label(boxes) @@ -1280,6 +1628,7 @@ def _validate_jpx_box_sequence(boxes): _validate_singletons(boxes) _validate_top_level(boxes) + def _validate_signature_compatibility(boxes): """Validate the file signature and compatibility status.""" # Check for a bad sequence of boxes. @@ -1352,14 +1701,14 @@ def _validate_channel_definition(jp2h, colr): raise IOError(msg) elif len(cdef_lst) == 1: cdef = jp2h.box[cdef_lst[0]] - if colr.colorspace == SRGB: + if colr.colorspace == core.SRGB: if any([chan + 1 not in cdef.association or cdef.channel_type[chan] != 0 for chan in [0, 1, 2]]): msg = "All color channels must be defined in the " msg += "channel definition box." raise IOError(msg) - elif colr.colorspace == GREYSCALE: + elif colr.colorspace == core.GREYSCALE: if 0 not in cdef.channel_type: msg = "All color channels must be defined in the " msg += "channel definition box." @@ -1367,6 +1716,8 @@ def _validate_channel_definition(jp2h, colr): JP2H_CHILDREN = set(['bpcc', 'cdef', 'cmap', 'ihdr', 'pclr']) + + def _check_jp2h_child_boxes(boxes, parent_box_name): """Certain boxes can only reside in the JP2 header.""" box_ids = set([box.box_id for box in boxes]) @@ -1394,6 +1745,7 @@ def _collect_box_count(boxes): TOP_LEVEL_ONLY_BOXES = set(['dtbl']) + def _check_superbox_for_top_levels(boxes): """Several boxes can only occur at the top level.""" # We are only looking at the boxes contained in a superbox, so if any of @@ -1409,6 +1761,7 @@ def _check_superbox_for_top_levels(boxes): if hasattr(box, 'box'): _check_superbox_for_top_levels(box.box) + def _validate_top_level(boxes): """Several boxes can only occur at the top level.""" # Add the counts in the superboxes. @@ -1428,6 +1781,7 @@ def _validate_top_level(boxes): msg += 'a fragment table box as well.' raise IOError(msg) + def _validate_singletons(boxes): """Several boxes can only occur once.""" count = _collect_box_count(boxes) @@ -1436,6 +1790,9 @@ def _validate_singletons(boxes): if 'dtbl' in multiples: raise IOError('There can only be one dtbl box in a file.') +JPX_IDS = ['asoc', 'nlst'] + + def _validate_jpx_brand(boxes, brand): """ If there is a JPX box then the brand must be 'jpx '. @@ -1450,6 +1807,7 @@ def _validate_jpx_brand(boxes, brand): # Same set of checks on any child boxes. _validate_jpx_brand(box.box, brand) + def _validate_jpx_compatibility(boxes, compatibility_list): """ If there is a JPX box then the compatibility list must also contain 'jpx '. @@ -1465,6 +1823,7 @@ def _validate_jpx_compatibility(boxes, compatibility_list): # Same set of checks on any child boxes. _validate_jpx_compatibility(box.box, compatibility_list) + def _validate_label(boxes): """ Label boxes can only be inside association, codestream headers, or @@ -1481,6 +1840,7 @@ def _validate_label(boxes): # Same set of checks on any child boxes. _validate_label(box.box) + def extract_image_cube(image): """Extract 3D image from openjpeg data structure. """ @@ -1536,206 +1896,6 @@ def extract_image_bands(image): return data -def _unpack_colorspace(colorspace, img_array, cparams): - """Determine the colorspace from the supplied inputs. - - Parameters - ---------- - colorspace : int - Either CLRSPC_SRGB or CLRSPC_GRAY - img_array : ndarray - Image data to be written to file. - cparams : CompressionParametersType(ctypes.Structure) - Corresponds to cparameters_t type in openjp2 headers. - """ - if colorspace is None: - # Must infer the colorspace from the image dimensions. - if img_array.ndim < 3: - # A single channel image is grayscale. - colorspace = opj2.CLRSPC_GRAY - elif img_array.shape[2] == 1 or img_array.shape[2] == 2: - # A single channel image or an image with two channels is going - # to be greyscale. - colorspace = opj2.CLRSPC_GRAY - else: - # Anything else must be RGB, right? - colorspace = opj2.CLRSPC_SRGB - else: - # Supplied a string colorspace, so we must validate it. - if cparams.codec_fmt == opj2.CODEC_J2K: - msg = 'Do not specify a colorspace when writing a raw ' - msg += 'codestream.' - raise IOError(msg) - if colorspace.lower() not in ('rgb', 'grey', 'gray'): - msg = 'Invalid colorspace "{0}"'.format(colorspace) - raise IOError(msg) - elif colorspace.lower() == 'rgb' and img_array.shape[2] < 3: - msg = 'RGB colorspace requires at least 3 components.' - raise IOError(msg) - - # Turn the colorspace from a string to the enumerated value that - # the library expects. - colorspace = _COLORSPACE_MAP[colorspace.lower()] - - return colorspace - - -def _populate_comptparms(img_array, cparams): - """Instantiate and populate comptparms structure. - - This structure defines the image components. - - Parameters - ---------- - img_array : ndarray - Image data to be written to file. - cparams : CompressionParametersType(ctypes.Structure) - Corresponds to cparameters_t type in openjp2 headers. - - Returns - ------- - comptparms : ImageCompType(ctypes.Structure) - Corresponds to image_comp_t type in openjp2 headers. - """ - # Only two precisions are possible. - if img_array.dtype == np.uint8: - comp_prec = 8 - else: - comp_prec = 16 - - numrows, numcols, num_comps = img_array.shape - if version.openjpeg_version_tuple[0] == 1: - comptparms = (opj.ImageComptParmType * num_comps)() - else: - comptparms = (opj2.ImageComptParmType * num_comps)() - for j in range(num_comps): - comptparms[j].dx = cparams.subsampling_dx - comptparms[j].dy = cparams.subsampling_dy - comptparms[j].w = numcols - comptparms[j].h = numrows - comptparms[j].x0 = cparams.image_offset_x0 - comptparms[j].y0 = cparams.image_offset_y0 - comptparms[j].prec = comp_prec - comptparms[j].bpp = comp_prec - comptparms[j].sgnd = 0 - - return comptparms - - -def _populate_image_struct(cparams, image, imgdata): - """Populates image struct needed for compression. - - Parameters - ---------- - cparams : CompressionParametersType(ctypes.Structure) - Corresponds to cparameters_t type in openjp2 headers. - image : ImageType(ctypes.Structure) - Corresponds to image_t type in openjp2 headers. - imgarray : ndarray - Image data to be written to file. - """ - - numrows, numcols, num_comps = imgdata.shape - - # set image offset and reference grid - image.contents.x0 = cparams.image_offset_x0 - image.contents.y0 = cparams.image_offset_y0 - image.contents.x1 = (image.contents.x0 + - (numcols - 1) * cparams.subsampling_dx + 1) - image.contents.y1 = (image.contents.y0 + - (numrows - 1) * cparams.subsampling_dy + 1) - - # Stage the image data to the openjpeg data structure. - for k in range(0, num_comps): - if re.match("2.0", version.openjpeg_version) is not None: - # 2.0 API - if cparams.cp_cinema: - image.contents.comps[k].prec = 12 - image.contents.comps[k].bpp = 12 - else: - # 2.1 API - if cparams.rsiz in (core.OPJ_PROFILE_CINEMA_2K, - core.OPJ_PROFILE_CINEMA_4K): - image.contents.comps[k].prec = 12 - image.contents.comps[k].bpp = 12 - - layer = np.ascontiguousarray(imgdata[:, :, k], dtype=np.int32) - dest = image.contents.comps[k].data - src = layer.ctypes.data - ctypes.memmove(dest, src, layer.nbytes) - - return image - - -def _validate_compression_params(img_array, cparams): - """Check that the compression parameters are valid. - - Parameters - ---------- - img_array : ndarray - Image data to be written to file. - cparams : CompressionParametersType(ctypes.Structure) - Corresponds to cparameters_t type in openjp2 headers. - """ - - # Code block size - code_block_specified = False - if cparams.cblockw_init != 0 and cparams.cblockh_init != 0: - # These fields ARE zero if uninitialized. - width = cparams.cblockw_init - height = cparams.cblockh_init - code_block_specified = True - if height * width > 4096 or height < 4 or width < 4: - msg = "Code block area cannot exceed 4096. " - msg += "Code block height and width must be larger than 4." - raise IOError(msg) - if ((math.log(height, 2) != math.floor(math.log(height, 2)) or - math.log(width, 2) != math.floor(math.log(width, 2)))): - msg = "Bad code block size ({0}, {1}), " - msg += "must be powers of 2." - raise IOError(msg.format(height, width)) - - # Precinct size - if cparams.res_spec != 0: - # precinct size was not specified if this field is zero. - for j in range(cparams.res_spec): - prch = cparams.prch_init[j] - prcw = cparams.prcw_init[j] - if j == 0 and code_block_specified: - height, width = cparams.cblockh_init, cparams.cblockw_init - if height * 2 > prch or width * 2 > prcw: - msg = "Highest Resolution precinct size must be at " - msg += "least twice that of the code block dimensions." - raise IOError(msg) - if ((math.log(prch, 2) != math.floor(math.log(prch, 2)) or - math.log(prcw, 2) != math.floor(math.log(prcw, 2)))): - msg = "Bad precinct sizes ({0}, {1}), " - msg += "must be powers of 2." - raise IOError(msg.format(prch, prcw)) - - # What would the point of 1D images be? - if img_array.ndim == 1 or img_array.ndim > 3: - msg = "{0}D imagery is not allowed.".format(img_array.ndim) - raise IOError(msg) - - if re.match("2.0.0", version.openjpeg_version) is not None: - if (((img_array.ndim != 2) and - (img_array.shape[2] != 1 and img_array.shape[2] != 3))): - msg = "Writing images is restricted to single-channel " - msg += "greyscale images or three-channel RGB images when " - msg += "the OpenJPEG library version is the official 2.0.0 " - msg += "release." - raise IOError(msg) - - if img_array.dtype != np.uint8 and img_array.dtype != np.uint16: - msg = "Only uint8 and uint16 images are currently supported." - raise RuntimeError(msg) - -_COLORSPACE_MAP = {'rgb': opj2.CLRSPC_SRGB, - 'gray': opj2.CLRSPC_GRAY, - 'grey': opj2.CLRSPC_GRAY, - 'ycc': opj2.CLRSPC_YCC} - # Setup the default callback handlers. See the callback functions subsection # in the ctypes section of the Python documentation for a solid explanation of # what's going on here. @@ -1762,10 +1922,3 @@ def _default_warning_handler(library_msg, _): _ERROR_CALLBACK = _CMPFUNC(_default_error_handler) _INFO_CALLBACK = _CMPFUNC(_default_info_handler) _WARNING_CALLBACK = _CMPFUNC(_default_warning_handler) - - -class LibraryNotFoundError(IOError): - """Raised if functionality is requested without the necessary library. - """ - def __init__(self, msg): - IOError.__init__(self, msg) diff --git a/glymur/lib/__init__.py b/glymur/lib/__init__.py index a283f7f..ddce813 100644 --- a/glymur/lib/__init__.py +++ b/glymur/lib/__init__.py @@ -2,3 +2,5 @@ from . import openjp2 as openjp2 from . import openjpeg as openjpeg from . import c + +__all__ = [openjp2, openjpeg, c] diff --git a/glymur/lib/config.py b/glymur/lib/config.py index fdb5a92..8af038a 100644 --- a/glymur/lib/config.py +++ b/glymur/lib/config.py @@ -1,9 +1,6 @@ """ Configure glymur to use installed libraries if possible. """ -# configparser is new in python3 (pylint/python-2.7) -# pylint: disable=F0401 - import ctypes from ctypes.util import find_library import os @@ -18,6 +15,22 @@ else: from configparser import ConfigParser from configparser import NoOptionError +# default library locations for MacPorts +_macports_default_location = {'openjp2': '/opt/local/lib/libopenjp2.dylib', + 'openjpeg': '/opt/local/lib/libopenjpeg.dylib'} + +# default library locations on Windows +_windows_default_location = {'openjp2': os.path.join('C:\\', + 'Program files', + 'OpenJPEG 2.0', + 'bin', + 'openjp2.dll'), + 'openjpeg': os.path.join('C:\\', + 'Program files', + 'OpenJPEG 1.5', + 'bin', + 'openjpeg.dll')} + def glymurrc_fname(): """Return the path to the configuration file. @@ -43,52 +56,23 @@ def glymurrc_fname(): return None -def load_openjpeg(path): - """Load the openjpeg library, falling back on defaults if necessary. +def load_openjpeg_library(libname): - Parameters - ---------- - path : str - Path to openjpeg 1.5 library as specified by configuration file. Will - be None if no configuration file specified. - """ - if path is None: - # Let ctypes try to find it. - path = find_library('openjpeg') + path = read_config_file(libname) + if path is not None: + return load_library_handle(path) - # If we could not find it, then look in some likely locations on mac - # and win. - if path is None: - # Could not find a library via ctypes - if platform.system() == 'Darwin': - # MacPorts - path = '/opt/local/lib/libopenjpeg.dylib' - elif os.name == 'nt': - path = os.path.join('C:\\', 'Program files', 'OpenJPEG 1.5', - 'bin', 'openjpeg.dll') - - if path is not None and not os.path.exists(path): - # the mac/win default location does not exist. - return None - - return load_library_handle(path) - - -def load_openjp2(path): - """Load the openjp2 library, falling back on defaults if necessary. - """ - if path is None: - # No help from the config file, try to find it via ctypes. - path = find_library('openjp2') + # No location specified by the configuration file, must look for it + # elsewhere. + path = find_library(libname) if path is None: # Could not find a library via ctypes if platform.system() == 'Darwin': # MacPorts - path = '/opt/local/lib/libopenjp2.dylib' + path = _macports_default_location[libname] elif os.name == 'nt': - path = os.path.join('C:\\', 'Program files', 'OpenJPEG 2.0', - 'bin', 'openjp2.dll') + path = _windows_default_location[libname] if path is not None and not os.path.exists(path): # the mac/win default location does not exist. @@ -100,10 +84,11 @@ def load_openjp2(path): def load_library_handle(path): """Load the library, return the ctypes handle.""" - if path is None: - # Either could not find a library via ctypes or user-configuration-file, - # or we could not find it in any of the default locations. - # This is probably a very old linux. + if path is None or path in ['None', 'none']: + # Either could not find a library via ctypes or + # user-configuration-file, or we could not find it in any of the + # default locations, or possibly the user intentionally does not want + # one of the libraries to load. return None try: @@ -112,47 +97,59 @@ def load_library_handle(path): else: opj_lib = ctypes.CDLL(path) except (TypeError, OSError): - msg = '"Library {0}" could not be loaded. Operating in degraded mode.' - msg = msg.format(path) - warnings.warn(msg, UserWarning) - opj_lib = None + msg = 'The library specified by configuration file at {0} could not ' + msg += 'be loaded.' + warnings.warn(msg.format(path), UserWarning) + opj_lib = None return opj_lib -def read_config_file(): +def read_config_file(libname): """ - We must use a configuration file that the user must write. - """ - lib = {'openjp2': None, 'openjpeg': None} - filename = glymurrc_fname() - if filename is not None: - # Read the configuration file for the library location. - parser = ConfigParser() - parser.read(filename) - try: - lib['openjp2'] = parser.get('library', 'openjp2') - except NoOptionError: - pass - try: - lib['openjpeg'] = parser.get('library', 'openjpeg') - except NoOptionError: - pass + Extract library locations from a configuration file. - return lib + Parameters + ---------- + libname : str + One of either 'openjp2' or 'openjpeg' + + Returns + ------- + path : None or str + None if no location is specified, otherwise a path to the library + """ + filename = glymurrc_fname() + if filename is None: + # There's no library file path to return in this case. + return None + + # Read the configuration file for the library location. + parser = ConfigParser() + parser.read(filename) + try: + path = parser.get('library', libname) + except NoOptionError: + path = None + return path def glymur_config(): - """Try to ascertain locations of openjp2, openjpeg libraries. """ - libs = read_config_file() - libopenjp2_handle = load_openjp2(libs['openjp2']) - libopenjpeg_handle = load_openjpeg(libs['openjpeg']) - if libopenjp2_handle is None and libopenjpeg_handle is None: + Try to ascertain locations of openjp2, openjpeg libraries. + + Returns + ------- + tpl : tuple + tuple of library handles + """ + lst = [] + for libname in ['openjp2', 'openjpeg']: + lst.append(load_openjpeg_library(libname)) + if all(handle is None for handle in lst): msg = "Neither the openjp2 nor the openjpeg library could be loaded. " - msg += "Operating in severely degraded mode." - warnings.warn(msg, UserWarning) - return libopenjp2_handle, libopenjpeg_handle + warnings.warn(msg) + return tuple(lst) def get_configdir(): diff --git a/glymur/lib/openjp2.py b/glymur/lib/openjp2.py index 5b5f3c4..aed4db6 100644 --- a/glymur/lib/openjp2.py +++ b/glymur/lib/openjp2.py @@ -2,15 +2,16 @@ Wraps individual functions in openjp2 library. """ -# pylint: disable=C0302,R0903,W0201 - import ctypes import re import sys +import textwrap from .config import glymur_config + OPENJP2, OPENJPEG = glymur_config() + def version(): """Wrapper for opj_version library routine.""" try: @@ -48,13 +49,6 @@ JPWL_MAX_NO_TILESPECS = 16 TRUE = 1 FALSE = 0 -#PROFILE = {'none': 0, # No profile -# 0: 1, # Profile 0 -# 1: 2, # Profile 1 -# 'part2': 0x8000, # At least one extension -# 'Cinema2K': 0x0003, # 2K cinema profile -# 'Cinema4K': 0x0004, # 4K cinema profile - # supported color spaces CLRSPC_UNKNOWN = -1 CLRSPC_UNSPECIFIED = 0 @@ -137,6 +131,13 @@ class PocType(ctypes.Structure): ("tx0_t", ctypes.c_uint32), ("ty0_t", ctypes.c_uint32)] + def __str__(self): + msg = "{0}:\n".format(self.__class__) + for field_name, _ in self._fields_: + msg += " {0}: {1}\n".format( + field_name, getattr(self, field_name)) + return msg + class DecompressionParametersType(ctypes.Structure): """Decompression parameters. @@ -200,6 +201,13 @@ class DecompressionParametersType(ctypes.Structure): # maximum number of tiles ("flags", ctypes.c_uint32)] + def __str__(self): + msg = "{0}:\n".format(self.__class__) + for field_name, _ in self._fields_: + msg += " {0}: {1}\n".format( + field_name, getattr(self, field_name)) + return msg + class CompressionParametersType(ctypes.Structure): """Compression parameters. @@ -391,6 +399,46 @@ class CompressionParametersType(ctypes.Structure): # values. _fields_.append(("rsiz", ctypes.c_uint16)) + def __str__(self): + msg = "{0}:\n".format(self.__class__) + for field_name, _ in self._fields_: + + if field_name == 'poc': + msg += " numpocs: {0}\n".format(self.numpocs) + for j in range(self.numpocs): + msg += " [#{0}]:".format(j) + msg += " {0}".format(str(self.poc[j])) + + elif field_name in ['tcp_rates', 'tcp_distoratio']: + lst = [] + arr = getattr(self, field_name) + lst = [arr[j] for j in range(self.tcp_numlayers)] + msg += " {0}: {1}\n".format(field_name, lst) + + elif field_name in ['prcw_init', 'prch_init']: + pass + + elif field_name == 'res_spec': + prcw_init = [self.prcw_init[j] for j in range(self.res_spec)] + prch_init = [self.prch_init[j] for j in range(self.res_spec)] + msg += " res_spec: {0}\n".format(self.res_spec) + msg += " prch_init: {0}\n".format(prch_init) + msg += " prcw_init: {0}\n".format(prcw_init) + + elif field_name in [ + 'jpwl_hprot_tph_tileno', 'jpwl_hprot_tph', + 'jpwl_pprot_tileno', 'jpwl_pprot_packno', 'jpwl_pprot', + 'jpwl_sens_tph_tileno', 'jpwl_sens_tph']: + arr = getattr(self, field_name) + lst = [arr[j] for j in range(JPWL_MAX_NO_TILESPECS)] + msg += " {0}: {1}\n".format(field_name, lst) + + else: + msg += " {0}: {1}\n".format( + field_name, getattr(self, field_name)) + return msg + + class ImageCompType(ctypes.Structure): """Defines a single image component. @@ -432,6 +480,14 @@ class ImageCompType(ctypes.Structure): if _MINOR == '1': _fields_.append(("alpha", ctypes.c_uint16)) + def __str__(self): + msg = "{0}:\n".format(self.__class__) + for field_name, _ in self._fields_: + msg += " {0}: {1}\n".format( + field_name, getattr(self, field_name)) + return msg + + class ImageType(ctypes.Structure): """Defines image data and characteristics. @@ -462,6 +518,26 @@ class ImageType(ctypes.Structure): # restricted ICC profile buffer length ("icc_profile_len", ctypes.c_uint32)] + def __str__(self): + msg = "{0}:\n".format(self.__class__) + for field_name, _ in self._fields_: + + if field_name == "numcomps": + msg += " numcomps: {0}\n".format(self.numcomps) + for j in range(self.numcomps): + msg += " comps[#{0}]:\n".format(j) + msg += textwrap.indent(str(self.comps[j]), ' ' * 12) + + elif field_name == "comps": + # handled above + pass + + else: + msg += " {0}: {1}\n".format( + field_name, getattr(self, field_name)) + + return msg + class ImageComptParmType(ctypes.Structure): """Component parameters structure used by image_create function. @@ -491,106 +567,12 @@ class ImageComptParmType(ctypes.Structure): # signed (1) / unsigned (0) ("sgnd", ctypes.c_uint32)] - -class TccpInfo(ctypes.Structure): - """Tile-component coding parameters information. - - Corresponds to tccp_info_t type in openjp2 header file. - """ - _fields_ = [ - # component index - ("compno", ctypes.c_uint32), - - # coding style - ("csty", ctypes.c_uint32), - - # number of resolutions - ("numresolutions", ctypes.c_uint32), - - # code-blocks width - ("cblkw", ctypes.c_uint32), - - # code-blocks height - ("cblkh", ctypes.c_uint32), - - # code-block coding style - ("cblksty", ctypes.c_uint32), - - # discrete wavelet transform identifier - ("qmfbid", ctypes.c_uint32), - - # quantization style - ("qntsty", ctypes.c_uint32), - - # stepsizes used for quantization - ("stepsizes_mant", ctypes.c_uint32 * J2K_MAXBANDS), - ("stepsizes_expn", ctypes.c_uint32 * J2K_MAXBANDS), - - # stepsizes used for quantization - ("numgbits", ctypes.c_uint32), - - # region of interest shift - ("roishift", ctypes.c_int32), - - # precinct width - ("prcw", ctypes.c_uint32 * J2K_MAXRLVLS), - - # precinct width - ("prch", ctypes.c_uint32 * J2K_MAXRLVLS)] - - -class TileInfoV2(ctypes.Structure): - """Tile coding parameters information - - Corresponds to tile_info_v2_t type in openjp2 headers. - """ - _fields_ = [ - # number (index) of tile - ("tileno", ctypes.c_int32), - - # coding style - ("csty", ctypes.c_uint32), - - # progression order - ("prg", PROG_ORDER_TYPE), - - # number of layers - ("numlayers", ctypes.c_uint32), - - # multi-component transform identifier - ("mct", ctypes.c_uint32), - - # information concerning tile component parameters - ("tccp_info", ctypes.POINTER(TccpInfo))] - - -class CodestreamInfoV2(ctypes.Structure): - """information about the codestream. - - Corresponds to codestream_info_v2_t type in openjp2 header files. - """ - _fields_ = [ - # tile info - # tile origin in x, y (XTOsiz, YTOsiz) - ("tx0", ctypes.c_uint32), - ("ty0", ctypes.c_uint32), - - # tile size in x, y = XTsiz, YTsiz - ("tdx", ctypes.c_uint32), - ("tdy", ctypes.c_uint32), - - # number of tiles in X, Y - ("tw", ctypes.c_uint32), - ("th", ctypes.c_uint32), - - # number of components - ("nbcomps", ctypes.c_uint32), - - # default information regarding tiles inside of image - ("m_default_tile_info", TileInfoV2), - - # information regarding tiles inside of image - ("tile_info", ctypes.POINTER(TileInfoV2))] + def __str__(self): + msg = "{0}:\n".format(self.__class__) + for field_name, _ in self._fields_: + msg += " {0}: {1}\n".format( + field_name, getattr(self, field_name)) + return msg def check_error(status): @@ -755,28 +737,6 @@ def encode(codec, stream): OPENJP2.opj_encode(codec, stream) -def get_cstr_info(codec): - """get the codestream information from the codec - - Wraps the openjp2 library function opj_get_cstr_info. - - Parameters - ---------- - codec : CODEC_TYPE - The jpeg2000 codec. - - Returns - ------- - cstr_info_p : CodestreamInfoV2 - Reference to codestream information. - """ - OPENJP2.opj_get_cstr_info.argtypes = [CODEC_TYPE] - OPENJP2.opj_get_cstr_info.restype = ctypes.POINTER(CodestreamInfoV2) - - cstr_info_p = OPENJP2.opj_get_cstr_info(codec) - return cstr_info_p - - def get_decoded_tile(codec, stream, imagep, tile_index): """get the decoded tile from the codec @@ -807,23 +767,6 @@ def get_decoded_tile(codec, stream, imagep, tile_index): OPENJP2.opj_get_decoded_tile(codec, stream, imagep, tile_index) -def destroy_cstr_info(cstr_info_p): - """destroy codestream information after compression or decompression - - Wraps the openjp2 library function opj_destroy_cstr_info. - - Parameters - ---------- - cstr_info_p : CodestreamInfoV2 pointer - Pointer to codestream info structure. - """ - ARGTYPES = [ctypes.POINTER(ctypes.POINTER(CodestreamInfoV2))] - OPENJP2.opj_destroy_cstr_info.argtypes = ARGTYPES - OPENJP2.opj_destroy_cstr_info.restype = ctypes.c_void_p - - OPENJP2.opj_destroy_cstr_info(ctypes.byref(cstr_info_p)) - - def end_compress(codec, stream): """End of compressing the current image. @@ -966,7 +909,7 @@ def read_header(stream, codec): ARGTYPES = [STREAM_TYPE_P, CODEC_TYPE, ctypes.POINTER(ctypes.POINTER(ImageType))] OPENJP2.opj_read_header.argtypes = ARGTYPES - OPENJP2.opj_read_header.restype = check_error + OPENJP2.opj_read_header.restype = check_error imagep = ctypes.POINTER(ImageType)() OPENJP2.opj_read_header(stream, codec, ctypes.byref(imagep)) @@ -1325,6 +1268,7 @@ def _stream_create_default_file_stream_2p0(fptr, isa_read_stream): stream = OPENJP2.opj_stream_create_default_file_stream(fptr, read_stream) return stream + def _stream_create_default_file_stream_2p1(fname, isa_read_stream): """Wraps openjp2 library function opj_stream_create_default_vile_stream. @@ -1351,7 +1295,7 @@ def _stream_create_default_file_stream_2p1(fname, isa_read_stream): stream = OPENJP2.opj_stream_create_default_file_stream(file_argument, read_stream) return stream - + if re.match(r'''2.0''', version()): stream_create_default_file_stream = _stream_create_default_file_stream_2p0 else: diff --git a/glymur/lib/openjpeg.py b/glymur/lib/openjpeg.py index 418e9df..d2f156b 100644 --- a/glymur/lib/openjpeg.py +++ b/glymur/lib/openjpeg.py @@ -1,14 +1,11 @@ """Wraps library calls to openjpeg. """ -# pylint: disable=R0903 - import ctypes import sys -import numpy as np - from .config import glymur_config + _, OPENJPEG = glymur_config() # Maximum number of tile parts expected by JPWL: increase at your will @@ -58,8 +55,10 @@ class CommonStructType(ctypes.Structure): ("mj2_handle", ctypes.c_void_p)] -STREAM_READ = 0x0001 # The stream was opened for reading. -STREAM_WRITE = 0x0002 # The stream was opened for writing. +STREAM_READ = 0x0001 # The stream was opened for reading. +STREAM_WRITE = 0x0002 # The stream was opened for writing. + + class CioType(ctypes.Structure): """Byte input-output stream (CIO) @@ -90,70 +89,57 @@ class CompressionInfoType(CommonStructType): class PocType(ctypes.Structure): """Progression order changes.""" _fields_ = [("resno", ctypes.c_int), - # Resolution num start, Component num start, given by POC - ("compno0", ctypes.c_int), + # Resolution num start, Component num start, given by POC + ("compno0", ctypes.c_int), - # Layer num end,Resolution num end, Component num end, given by POC - ("layno1", ctypes.c_int), - ("resno1", ctypes.c_int), - ("compno1", ctypes.c_int), + # Layer num end,Resolution num end, Component num end, given + # by POC + ("layno1", ctypes.c_int), + ("resno1", ctypes.c_int), + ("compno1", ctypes.c_int), - # Layer num start,Precinct num start, Precinct num end - ("layno0", ctypes.c_int), - ("precno0", ctypes.c_int), - ("precno1", ctypes.c_int), + # Layer num start,Precinct num start, Precinct num end + ("layno0", ctypes.c_int), + ("precno0", ctypes.c_int), + ("precno1", ctypes.c_int), - # Progression order enum - # OPJ_PROG_ORDER prg1,prg; - ("prg1", ctypes.c_int), - ("prg", ctypes.c_int), + # Progression order enum + # OPJ_PROG_ORDER prg1,prg; + ("prg1", ctypes.c_int), + ("prg", ctypes.c_int), - # Progression order string - # char progorder[5]; - ("progorder", ctypes.c_char * 5), + # Progression order string + # char progorder[5]; + ("progorder", ctypes.c_char * 5), - # Tile number - # int tile; - ("tile", ctypes.c_int), + # Tile number + # int tile; + ("tile", ctypes.c_int), - # /** Start and end values for Tile width and height*/ - # int tx0,tx1,ty0,ty1; - ("tx0", ctypes.c_int), - ("tx1", ctypes.c_int), - ("ty0", ctypes.c_int), - ("ty1", ctypes.c_int), - - # /** Start value, initialised in pi_initialise_encode*/ - # int layS, resS, compS, prcS; - ("layS", ctypes.c_int), - ("resS", ctypes.c_int), - ("compS", ctypes.c_int), - ("prcS", ctypes.c_int), - - # /** End value, initialised in pi_initialise_encode */ - # int layE, resE, compE, prcE; - ("layE", ctypes.c_int), - ("resE", ctypes.c_int), - ("compE", ctypes.c_int), - ("prcE", ctypes.c_int), - - # Start and end values of Tile width and height, initialised in - # pi_initialise_encode int txS,txE,tyS,tyE,dx,dy; - ("txS", ctypes.c_int), - ("txE", ctypes.c_int), - ("tyS", ctypes.c_int), - ("tyE", ctypes.c_int), - ("dx", ctypes.c_int), - ("dy", ctypes.c_int), - - # Temporary values for Tile parts, initialised in pi_create_encode - # int lay_t, res_t, comp_t, prc_t,tx0_t,ty0_t; - ("lay_t", ctypes.c_int), - ("res_t", ctypes.c_int), - ("comp_t", ctypes.c_int), - ("prc_t", ctypes.c_int), - ("tx0_t", ctypes.c_int), - ("ty0_t", ctypes.c_int)] + ("tx0", ctypes.c_int), + ("tx1", ctypes.c_int), + ("ty0", ctypes.c_int), + ("ty1", ctypes.c_int), + ("layS", ctypes.c_int), + ("resS", ctypes.c_int), + ("compS", ctypes.c_int), + ("prcS", ctypes.c_int), + ("layE", ctypes.c_int), + ("resE", ctypes.c_int), + ("compE", ctypes.c_int), + ("prcE", ctypes.c_int), + ("txS", ctypes.c_int), + ("txE", ctypes.c_int), + ("tyS", ctypes.c_int), + ("tyE", ctypes.c_int), + ("dx", ctypes.c_int), + ("dy", ctypes.c_int), + ("lay_t", ctypes.c_int), + ("res_t", ctypes.c_int), + ("comp_t", ctypes.c_int), + ("prc_t", ctypes.c_int), + ("tx0_t", ctypes.c_int), + ("ty0_t", ctypes.c_int)] class CompressionParametersType(ctypes.Structure): @@ -374,48 +360,47 @@ class DecompressionParametersType(ctypes.Structure): class ImageComptParmType(ctypes.Structure): """Component parameters structure used by the opj_image_create function. """ - _fields_ = [ - # XRsiz: horizontal separation of a sample of ith component with - # respect to the reference grid - ("dx", ctypes.c_int), + _fields_ = [("dx", ctypes.c_int), + # XRsiz: horizontal separation of a sample of ith component + # with respect to the reference grid - # YRsiz: vertical separation of a sample of ith component with - # respect to the reference grid */ - ("dy", ctypes.c_int), + # YRsiz: vertical separation of a sample of ith component with + # respect to the reference grid */ + ("dy", ctypes.c_int), - # data width, height - ("w", ctypes.c_int), - ("h", ctypes.c_int), + # data width, height + ("w", ctypes.c_int), + ("h", ctypes.c_int), - # x component offset compared to the whole image - # y component offset compared to the whole image - ("x0", ctypes.c_int), - ("y0", ctypes.c_int), + # x component offset compared to the whole image + # y component offset compared to the whole image + ("x0", ctypes.c_int), + ("y0", ctypes.c_int), - # precision - ('prec', ctypes.c_int), + # precision + ('prec', ctypes.c_int), - # image depth in bits - ('bpp', ctypes.c_int), + # image depth in bits + ('bpp', ctypes.c_int), - # signed (1) / unsigned (0) - ('sgnd', ctypes.c_int)] + # signed (1) / unsigned (0) + ('sgnd', ctypes.c_int)] class ImageCompType(ctypes.Structure): """Defines a single image component. """ _fields_ = [("dx", ctypes.c_int), - ("dy", ctypes.c_int), - ("w", ctypes.c_int), - ("h", ctypes.c_int), - ("x0", ctypes.c_int), - ("y0", ctypes.c_int), - ("prec", ctypes.c_int), - ("bpp", ctypes.c_int), - ("sgnd", ctypes.c_int), - ("resno_decoded", ctypes.c_int), - ("factor", ctypes.c_int), - ("data", ctypes.POINTER(ctypes.c_int))] + ("dy", ctypes.c_int), + ("w", ctypes.c_int), + ("h", ctypes.c_int), + ("x0", ctypes.c_int), + ("y0", ctypes.c_int), + ("prec", ctypes.c_int), + ("bpp", ctypes.c_int), + ("sgnd", ctypes.c_int), + ("resno_decoded", ctypes.c_int), + ("factor", ctypes.c_int), + ("data", ctypes.POINTER(ctypes.c_int))] class ImageType(ctypes.Structure): @@ -467,6 +452,7 @@ def cio_tell(cio): pos = OPENJPEG.cio_tell(cio) return pos + def create_compress(fmt): """Wrapper for openjpeg library function opj_create_compress. @@ -537,56 +523,11 @@ def destroy_decompress(dinfo): OPENJPEG.opj_destroy_decompress(dinfo) -def image_cmptparm_t_from_np(np_image): - """Return appropriate image_cmptparm_t based on given numpy array. - """ - try: - num_comps = np_image.shape[2] - except IndexError: - num_comps = 1 - - cmpt_parm_array_t = ImageCmptparmType * num_comps - tarr = cmpt_parm_array_t() - - if np_image.dtype == np.uint8: - prec = 8 - bpp = 8 - sgnd = 0 - elif np_image.dtype == np.int8: - prec = 8 - bpp = 8 - sgnd = 1 - elif np_image.dtype == np.uint16: - prec = 16 - bpp = 16 - sgnd = 0 - elif np_image.dtype == np.int16: - prec = 16 - bpp = 16 - sgnd = 1 - else: - raise(TypeError("unhandled")) - - for j in range(0, num_comps): - tarr[j].dx = 1 - tarr[j].dy = 1 - tarr[j].w = np_image.shape[1] - tarr[j].h = np_image.shape[0] - tarr[j].x0 = 0 - tarr[j].y0 = 0 - tarr[j].prec = prec - tarr[j].bpp = bpp - tarr[j].sgnd = sgnd - - return(tarr) - - def image_create(cmptparms, cspace): """Wrapper for openjpeg library function opj_image_create. """ - OPENJPEG.opj_image_create.argtypes = [ctypes.c_int, - ctypes.POINTER(ImageComptParmType), - ctypes.c_int] + lst = [ctypes.c_int, ctypes.POINTER(ImageComptParmType), ctypes.c_int] + OPENJPEG.opj_image_create.argtypes = lst OPENJPEG.opj_image_create.restype = ctypes.POINTER(ImageType) image = OPENJPEG.opj_image_create(len(cmptparms), cmptparms, cspace) diff --git a/glymur/lib/test/fixtures.py b/glymur/lib/test/fixtures.py new file mode 100644 index 0000000..b5b9648 --- /dev/null +++ b/glymur/lib/test/fixtures.py @@ -0,0 +1,144 @@ +decompression_parameters_type = """: + cp_reduce: 0 + cp_layer: 0 + infile: b'' + outfile: b'' + decod_format: -1 + cod_format: -1 + DA_x0: 0 + DA_x1: 0 + DA_y0: 0 + DA_y1: 0 + m_verbose: 0 + tile_index: 0 + nb_tile_to_decode: 0 + jpwl_correct: 0 + jpwl_exp_comps: 0 + jpwl_max_tiles: 0 + flags: 0""" + +default_progression_order_changes_type = """: + resno0: 0 + compno0: 0 + layno1: 0 + resno1: 0 + compno1: 0 + layno0: 0 + precno0: 0 + precno1: 0 + prg1: 0 + prg: 0 + progorder: b'' + tile: 0 + tx0: 0 + tx1: 0 + ty0: 0 + ty1: 0 + layS: 0 + resS: 0 + compS: 0 + prcS: 0 + layE: 0 + resE: 0 + compE: 0 + prcE: 0 + txS: 0 + txE: 0 + tyS: 0 + tyE: 0 + dx: 0 + dy: 0 + lay_t: 0 + res_t: 0 + comp_t: 0 + prec_t: 0 + tx0_t: 0 + ty0_t: 0""" + +default_compression_parameters_type = """: + tile_size_on: 0 + cp_tx0: 0 + cp_ty0: 0 + cp_tdx: 0 + cp_tdy: 0 + cp_disto_alloc: 0 + cp_fixed_alloc: 0 + cp_fixed_quality: 0 + cp_matrice: None + cp_comment: None + csty: 0 + prog_order: 0 + numpocs: 0 + numpocs: 0 + tcp_numlayers: 0 + tcp_rates: [] + tcp_distoratio: [] + numresolution: 6 + cblockw_init: 64 + cblockh_init: 64 + mode: 0 + irreversible: 0 + roi_compno: -1 + roi_shift: 0 + res_spec: 0 + prch_init: [] + prcw_init: [] + infile: b'' + outfile: b'' + index_on: 0 + index: b'' + image_offset_x0: 0 + image_offset_y0: 0 + subsampling_dx: 1 + subsampling_dy: 1 + decod_format: -1 + cod_format: -1 + jpwl_epc_on: 0 + jpwl_hprot_mh: 0 + jpwl_hprot_tph_tileno: [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0] + jpwl_hprot_tph: [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0] + jpwl_pprot_tileno: [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0] + jpwl_pprot_packno: [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0] + jpwl_pprot: [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0] + jpwl_sens_size: 0 + jpwl_sens_addr: 0 + jpwl_sens_range: 0 + jpwl_sens_mh: 0 + jpwl_sens_tph_tileno: [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0] + jpwl_sens_tph: [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0] + cp_cinema: 0 + max_comp_size: 0 + cp_rsiz: 0 + tp_on: 0 + tp_flag: 0 + tcp_mct: 0 + jpip_on: 0 + mct_data: None + max_cs_size: 0 + rsiz: 0""" + +default_image_component_parameters = """: + dx: 0 + dy: 0 + w: 0 + h: 0 + x0: 0 + y0: 0 + prec: 0 + bpp: 0 + sgnd: 0""" + +# The "icc_profile_buf" field is problematic as it is a pointer value, i.e. +# +# icc_profile_buf: +# +# Have to treat it as a regular expression. +default_image_type = """: + x0: 0 + y0: 0 + x1: 0 + y1: 0 + numcomps: 0 + color_space: 0 + icc_profile_buf: + icc_profile_len: 0""" diff --git a/glymur/lib/test/test_openjp2.py b/glymur/lib/test/test_openjp2.py index 70ef9b6..c32ee89 100644 --- a/glymur/lib/test/test_openjp2.py +++ b/glymur/lib/test/test_openjp2.py @@ -1,13 +1,8 @@ """ Tests for libopenjp2 wrapping functions. """ -# R0904: Seems like pylint is fooled in this situation -# W0142: using kwargs is ok in this context -# pylint: disable=R0904,W0142 - import os import re -import sys import tempfile import unittest @@ -21,8 +16,8 @@ from glymur.lib import openjp2 @unittest.skipIf(openjp2.OPENJP2 is None, "Missing openjp2 library.") @unittest.skipIf(re.match(r'''(1|2.0)''', - glymur.version.openjpeg_version) is not None, - "Not to be run until 2.1.0") + glymur.version.openjpeg_version) is not None, + "Not to be run until 2.1.0") class TestOpenJP2(unittest.TestCase): """Test openjp2 library functionality. @@ -56,53 +51,6 @@ class TestOpenJP2(unittest.TestCase): self.assertEqual(dparams.DA_x1, 0) self.assertEqual(dparams.DA_y1, 0) - def tile_macro(self, codec, stream, imagep, tidx): - """called only by j2k_random_tile_access""" - openjp2.get_decoded_tile(codec, stream, imagep, tidx) - for j in range(imagep.contents.numcomps): - self.assertIsNotNone(imagep.contents.comps[j].data) - - def j2k_random_tile_access(self, filename, codec_format=None): - """fixture called by the test_rtaX methods""" - dparam = openjp2.set_default_decoder_parameters() - - infile = filename.encode() - nelts = openjp2.PATH_LEN - len(infile) - infile += b'0' * nelts - dparam.infile = infile - - dparam.decod_format = codec_format - - codec = openjp2.create_decompress(codec_format) - - openjp2.set_info_handler(codec, None) - openjp2.set_warning_handler(codec, None) - openjp2.set_error_handler(codec, None) - - stream = openjp2.stream_create_default_file_stream(filename, True) - - openjp2.setup_decoder(codec, dparam) - image = openjp2.read_header(stream, codec) - - cstr_info = openjp2.get_cstr_info(codec) - - tile_ul = 0 - tile_ur = cstr_info.contents.tw - 1 - tile_lr = cstr_info.contents.tw * cstr_info.contents.th - 1 - tile_ll = tile_lr - cstr_info.contents.tw - - self.tile_macro(codec, stream, image, tile_ul) - self.tile_macro(codec, stream, image, tile_ur) - self.tile_macro(codec, stream, image, tile_lr) - self.tile_macro(codec, stream, image, tile_ll) - - openjp2.destroy_cstr_info(cstr_info) - - openjp2.end_decompress(codec, stream) - openjp2.destroy_codec(codec) - openjp2.stream_destroy(stream) - openjp2.image_destroy(image) - def test_tte0(self): """Runs test designated tte0 in OpenJPEG test suite.""" with tempfile.NamedTemporaryFile(suffix=".j2k") as tfile: @@ -160,15 +108,6 @@ class TestOpenJP2(unittest.TestCase): tile_decoder(**kwargs) self.assertTrue(True) - def test_rta1(self): - """Runs test designated rta1 in OpenJPEG test suite.""" - with tempfile.NamedTemporaryFile(suffix=".j2k") as tfile: - self.xtx1_setup(tfile.name) - - codec_format = openjp2.CODEC_J2K - self.j2k_random_tile_access(tfile.name, codec_format) - self.assertTrue(True) - def test_tte2(self): """Runs test designated tte2 in OpenJPEG test suite.""" with tempfile.NamedTemporaryFile(suffix=".jp2") as tfile: @@ -190,62 +129,25 @@ class TestOpenJP2(unittest.TestCase): tile_decoder(**kwargs) self.assertTrue(True) - def test_rta2(self): - """Runs test designated rta2 in OpenJPEG test suite.""" - with tempfile.NamedTemporaryFile(suffix=".jp2") as tfile: - xtx2_setup(tfile.name) - - codec_format = openjp2.CODEC_JP2 - self.j2k_random_tile_access(tfile.name, codec_format) - def test_tte3(self): """Runs test designated tte3 in OpenJPEG test suite.""" with tempfile.NamedTemporaryFile(suffix=".j2k") as tfile: xtx3_setup(tfile.name) self.assertTrue(True) - def test_rta3(self): - """Runs test designated rta3 in OpenJPEG test suite.""" - with tempfile.NamedTemporaryFile(suffix=".j2k") as tfile: - xtx3_setup(tfile.name) - - codec_format = openjp2.CODEC_J2K - self.j2k_random_tile_access(tfile.name, codec_format) - self.assertTrue(True) - def test_tte4(self): """Runs test designated tte4 in OpenJPEG test suite.""" with tempfile.NamedTemporaryFile(suffix=".j2k") as tfile: xtx4_setup(tfile.name) self.assertTrue(True) - def test_rta4(self): - """Runs test designated rta4 in OpenJPEG test suite.""" - with tempfile.NamedTemporaryFile(suffix=".j2k") as tfile: - xtx4_setup(tfile.name) - - codec_format = openjp2.CODEC_J2K - self.j2k_random_tile_access(tfile.name, codec_format) - def test_tte5(self): """Runs test designated tte5 in OpenJPEG test suite.""" with tempfile.NamedTemporaryFile(suffix=".j2k") as tfile: xtx5_setup(tfile.name) self.assertTrue(True) - def test_rta5(self): - """Runs test designated rta5 in OpenJPEG test suite.""" - with tempfile.NamedTemporaryFile(suffix=".j2k") as tfile: - xtx5_setup(tfile.name) - codec_format = openjp2.CODEC_J2K - self.j2k_random_tile_access(tfile.name, codec_format) - - -#def tile_encoder(num_comps=None, tile_width=None, tile_height=None, -# filename=None, codec=None, comp_prec=None, -# image_width=None, image_height=None, -# irreversible=None): def tile_encoder(**kwargs): """Fixture used by many tests.""" num_tiles = ((kwargs['image_width'] / kwargs['tile_width']) * @@ -309,7 +211,7 @@ def tile_encoder(**kwargs): openjp2.setup_encoder(codec, l_param, l_image) stream = openjp2.stream_create_default_file_stream(kwargs['filename'], - False) + False) openjp2.start_compress(codec, l_image, stream) for j in np.arange(num_tiles): @@ -320,13 +222,14 @@ def tile_encoder(**kwargs): openjp2.destroy_codec(codec) openjp2.image_destroy(l_image) + def tile_decoder(**kwargs): """Fixture called with various configurations by many tests. Reads a tile. That's all it does. """ stream = openjp2.stream_create_default_file_stream(kwargs['filename'], - True) + True) dparam = openjp2.set_default_decoder_parameters() dparam.decod_format = kwargs['codec_format'] @@ -364,6 +267,7 @@ def tile_decoder(**kwargs): openjp2.stream_destroy(stream) openjp2.image_destroy(image) + def ttx0_setup(filename): """Runs tests tte0, tte0.""" kwargs = {'filename': filename, @@ -377,6 +281,7 @@ def ttx0_setup(filename): 'tile_width': 100} tile_encoder(**kwargs) + def xtx2_setup(filename): """Runs tests rta2, tte2, ttd2.""" kwargs = {'filename': filename, @@ -390,6 +295,7 @@ def xtx2_setup(filename): 'tile_width': 128} tile_encoder(**kwargs) + def xtx3_setup(filename): """Runs tests tte3, rta3.""" kwargs = {'filename': filename, @@ -403,6 +309,7 @@ def xtx3_setup(filename): 'tile_width': 128} tile_encoder(**kwargs) + def xtx4_setup(filename): """Runs tests rta4, tte4.""" kwargs = {'filename': filename, @@ -416,6 +323,7 @@ def xtx4_setup(filename): 'tile_width': 128} tile_encoder(**kwargs) + def xtx5_setup(filename): """Runs tests rta5, tte5.""" kwargs = {'filename': filename, @@ -428,6 +336,3 @@ def xtx5_setup(filename): 'tile_height': 256, 'tile_width': 256} tile_encoder(**kwargs) - -if __name__ == "__main__": - unittest.main() diff --git a/glymur/lib/test/test_openjpeg.py b/glymur/lib/test/test_openjpeg.py index f28656c..449083f 100644 --- a/glymur/lib/test/test_openjpeg.py +++ b/glymur/lib/test/test_openjpeg.py @@ -1,8 +1,6 @@ """ Tests for OpenJPEG module. """ -# pylint: disable=E1101,R0904 - import ctypes import re import sys @@ -10,6 +8,7 @@ import unittest import glymur + @unittest.skipIf(glymur.lib.openjpeg.OPENJPEG is None, "Missing openjpeg library.") class TestOpenJPEG(unittest.TestCase): diff --git a/glymur/lib/test/test_printing.py b/glymur/lib/test/test_printing.py new file mode 100644 index 0000000..c7be21c --- /dev/null +++ b/glymur/lib/test/test_printing.py @@ -0,0 +1,75 @@ +# -*- coding: utf-8 -*- +"""Test suite for printing. +""" + +import re +import sys +import unittest + +if sys.hexversion < 0x03000000: + from mock import patch + from StringIO import StringIO +else: + from unittest.mock import patch + from io import StringIO + +import glymur +from . import fixtures + + +@unittest.skipIf(sys.hexversion < 0x03000000, "do not care about 2.7 here") +@unittest.skipIf(re.match('0|1|2.0', glymur.version.openjpeg_version), + "Requires openjpeg 2.1.0 or higher") +class TestPrintingOpenjp2(unittest.TestCase): + """Tests for verifying how printing works on openjp2 library structures.""" + def setUp(self): + self.jp2file = glymur.data.nemo() + + def tearDown(self): + pass + + def test_decompression_parameters(self): + """printing DecompressionParametersType""" + dparams = glymur.lib.openjp2.set_default_decoder_parameters() + with patch('sys.stdout', new=StringIO()) as fake_out: + print(dparams) + actual = fake_out.getvalue().strip() + expected = fixtures.decompression_parameters_type + self.assertEqual(actual, expected) + + def test_progression_order_changes(self): + """printing PocType""" + ptype = glymur.lib.openjp2.PocType() + with patch('sys.stdout', new=StringIO()) as fake_out: + print(ptype) + actual = fake_out.getvalue().strip() + expected = fixtures.default_progression_order_changes_type + self.assertEqual(actual, expected) + + def test_default_compression_parameters(self): + """printing default compression parameters""" + cparams = glymur.lib.openjp2.set_default_encoder_parameters() + with patch('sys.stdout', new=StringIO()) as fake_out: + print(cparams) + actual = fake_out.getvalue().strip() + expected = fixtures.default_compression_parameters_type + self.assertEqual(actual, expected) + + def test_default_component_parameters(self): + """printing default image component parameters""" + icpt = glymur.lib.openjp2.ImageComptParmType() + with patch('sys.stdout', new=StringIO()) as fake_out: + print(icpt) + actual = fake_out.getvalue().strip() + expected = fixtures.default_image_component_parameters + self.assertEqual(actual, expected) + + def test_default_image_type(self): + """printing default image type""" + it = glymur.lib.openjp2.ImageType() + with patch('sys.stdout', new=StringIO()) as fake_out: + print(it) + actual = fake_out.getvalue().strip() + + expected = fixtures.default_image_type + self.assertRegex(actual, expected) diff --git a/glymur/test/fixtures.py b/glymur/test/fixtures.py index 0fc5be1..34327fc 100644 --- a/glymur/test/fixtures.py +++ b/glymur/test/fixtures.py @@ -5,12 +5,157 @@ import os import re import sys import textwrap +import unittest import warnings import numpy as np +import six import glymur +# If openjpeg is not installed, many tests cannot be run. +if glymur.version.openjpeg_version == '0.0.0': + OPENJPEG_NOT_AVAILABLE = True + OPENJPEG_NOT_AVAILABLE_MSG = 'OpenJPEG library not installed' +else: + OPENJPEG_NOT_AVAILABLE = False + OPENJPEG_NOT_AVAILABLE_MSG = None + +# Some versions of "six" on python3 cause problems when verifying warnings. +# Only use when the version is 1.7 or higher. +# And moreover, we only test using the 3.x infrastructure, never on 2.x. +WARNING_INFRASTRUCTURE_ISSUE = False +WARNING_INFRASTRUCTURE_MSG = "" +if sys.hexversion < 0x03000000: + WARNING_INFRASTRUCTURE_ISSUE = True + WARNING_INFRASTRUCTURE_MSG = "3.x warning infrastructure only" +elif re.match('1.[0-6]', six.__version__) is not None: + WARNING_INFRASTRUCTURE_ISSUE = True + msg = "Cannot run test with version {0} of python-six" + WARNING_INFRASTRUCTURE_MSG = msg.format(six.__version__) + +# Cannot reopen a named temporary file in windows. +WINDOWS_TMP_FILE_MSG = "cannot use NamedTemporaryFile like this in windows" + + +class MetadataBase(unittest.TestCase): + """ + Base class for testing metadata. + + This class has helper routines defined for testing metadata so that it can + be subclassed and used easily. + """ + + def setUp(self): + pass + + def tearDown(self): + pass + + def verify_codeblock_style(self, actual, style): + """ + Verify the code-block style for SPcod and SPcoc parameters. + + This information is stored in a single byte. Please reference + Table A-17 in FCD15444-1 + """ + expected = 0 + if style[0]: + # Selective arithmetic coding bypass + expected |= 0x01 + if style[1]: + # Reset context probabilities + expected |= 0x02 + if style[2]: + # Termination on each coding pass + expected |= 0x04 + if style[3]: + # Vertically causal context + expected |= 0x08 + if style[4]: + # Predictable termination + expected |= 0x10 + if style[5]: + # Segmentation symbols + expected |= 0x20 + self.assertEqual(actual, expected) + + def verifySignatureBox(self, box): + """ + The signature box is a constant. + """ + self.assertEqual(box.signature, (13, 10, 135, 10)) + + def verify_filetype_box(self, actual, expected): + """ + All JP2 files should have a brand reading 'jp2 ' and just a single + entry in the compatibility list, also 'jp2 '. JPX files can have more + compatibility items. + """ + self.assertEqual(actual.brand, expected.brand) + self.assertEqual(actual.minor_version, expected.minor_version) + self.assertEqual(actual.minor_version, 0) + for cl in expected.compatibility_list: + self.assertIn(cl, actual.compatibility_list) + + def verifyRGNsegment(self, actual, expected): + """ + verify the fields of a RGN segment + """ + self.assertEqual(actual.crgn, expected.crgn) # 0 = component + self.assertEqual(actual.srgn, expected.srgn) # 0 = implicit + self.assertEqual(actual.sprgn, expected.sprgn) + + def verifySOTsegment(self, actual, expected): + """ + verify the fields of a SOT (start of tile) segment + """ + self.assertEqual(actual.isot, expected.isot) + self.assertEqual(actual.psot, expected.psot) + self.assertEqual(actual.tpsot, expected.tpsot) + self.assertEqual(actual.tnsot, expected.tnsot) + + def verifyCMEsegment(self, actual, expected): + """ + verify the fields of a CME (comment) segment + """ + self.assertEqual(actual.rcme, expected.rcme) + self.assertEqual(actual.ccme, expected.ccme) + + def verifySizSegment(self, actual, expected): + """ + Verify the fields of the SIZ segment. + """ + for field in ['rsiz', 'xsiz', 'ysiz', 'xosiz', 'yosiz', 'xtsiz', + 'ytsiz', 'xtosiz', 'ytosiz', 'bitdepth', + 'xrsiz', 'yrsiz']: + self.assertEqual(getattr(actual, field), getattr(expected, field)) + + def verifyImageHeaderBox(self, box1, box2): + self.assertEqual(box1.height, box2.height) + self.assertEqual(box1.width, box2.width) + self.assertEqual(box1.num_components, box2.num_components) + self.assertEqual(box1.bits_per_component, box2.bits_per_component) + self.assertEqual(box1.signed, box2.signed) + self.assertEqual(box1.compression, box2.compression) + self.assertEqual(box1.colorspace_unknown, box2.colorspace_unknown) + self.assertEqual(box1.ip_provided, box2.ip_provided) + + def verifyColourSpecificationBox(self, actual, expected): + """ + Does not currently check icc profiles. + """ + self.assertEqual(actual.method, expected.method) + self.assertEqual(actual.precedence, expected.precedence) + self.assertEqual(actual.approximation, expected.approximation) + + if expected.colorspace is None: + self.assertIsNone(actual.colorspace) + self.assertIsNotNone(actual.icc_profile) + else: + self.assertEqual(actual.colorspace, expected.colorspace) + self.assertIsNone(actual.icc_profile) + # The Python XMP Toolkit may be used for XMP UUIDs, but only if available and # if the version is at least 2.0.0. @@ -37,6 +182,24 @@ except: raise +# The Cinema2K/4K tests seem to need the freeimage backend to skimage.io +# in order to work. Unfortunately, scikit-image/freeimage is about as wonky as +# it gets. Anaconda can get totally weirded out on versions up through 3.6.4 +# on Python3 with scikit-image up through version 0.10.0. +NO_SKIMAGE_FREEIMAGE_SUPPORT = False +try: + import skimage + import skimage.io + if (((sys.hexversion >= 0x03000000) and + ('Anaconda' in sys.version) and + (re.match('0.10', skimage.__version__)))): + NO_SKIMAGE_FREEIMAGE_SUPPORT = True + else: + skimage.io.use_plugin('freeimage', 'imread') +except ((ImportError, RuntimeError)): + NO_SKIMAGE_FREEIMAGE_SUPPORT = True + + def _indent(textstr): """ Indent a string. @@ -50,7 +213,7 @@ def _indent(textstr): String to be indented. indent_level : str Number of spaces of indentation to add. - + Returns ------- indented_string : str @@ -73,7 +236,6 @@ try: # The whole point of trying to import PIL is to determine if it's there # or not. We won't use it directly. - # pylint: disable=F0401,W0611 import PIL NO_READ_BACKEND = False @@ -383,7 +545,7 @@ text_gbr_34 = """Colour Specification Box (colr) @ (179, 1339) dump = r'''JPEG 2000 Signature Box (jP ) @ (0, 12) Signature: 0d0a870a File Type Box (ftyp) @ (12, 20) - Brand: jp2 + Brand: jp2 Compatibility: ['jp2 '] JP2 Header Box (jp2h) @ (32, 45) Image Header Box (ihdr) @ (40, 22) @@ -437,7 +599,8 @@ Contiguous Codestream Box (jp2c) @ (3223, 1132296) Step size: [(0, 8), (0, 9), (0, 9), (0, 10)] CME marker segment @ (3305, 37) "Created by OpenJPEG version 2.0.0"''' -nemo_dump_full = dump.format(_indent(nemo_xmp)) + +nemo_with_codestream_header = dump.format(_indent(nemo_xmp)) nemo_dump_short = r"""JPEG 2000 Signature Box (jP ) @ (0, 12) File Type Box (ftyp) @ (12, 20) @@ -450,7 +613,7 @@ Contiguous Codestream Box (jp2c) @ (3223, 1132296)""" nemo_dump_no_xml = '''JPEG 2000 Signature Box (jP ) @ (0, 12) Signature: 0d0a870a File Type Box (ftyp) @ (12, 20) - Brand: jp2 + Brand: jp2 Compatibility: ['jp2 '] JP2 Header Box (jp2h) @ (32, 45) Image Header Box (ihdr) @ (40, 22) @@ -506,7 +669,7 @@ Contiguous Codestream Box (jp2c) @ (3223, 1132296) dump = r"""JPEG 2000 Signature Box (jP ) @ (0, 12) Signature: 0d0a870a File Type Box (ftyp) @ (12, 20) - Brand: jp2 + Brand: jp2 Compatibility: ['jp2 '] JP2 Header Box (jp2h) @ (32, 45) Image Header Box (ihdr) @ (40, 22) @@ -529,7 +692,7 @@ nemo_dump_no_codestream = dump.format(_indent(nemo_xmp)) nemo_dump_no_codestream_no_xml = r"""JPEG 2000 Signature Box (jP ) @ (0, 12) Signature: 0d0a870a File Type Box (ftyp) @ (12, 20) - Brand: jp2 + Brand: jp2 Compatibility: ['jp2 '] JP2 Header Box (jp2h) @ (32, 45) Image Header Box (ihdr) @ (40, 22) @@ -546,6 +709,190 @@ UUID Box (uuid) @ (77, 3146) UUID: be7acfcb-97a9-42e8-9c71-999491e3afac (XMP) Contiguous Codestream Box (jp2c) @ (3223, 1132296)""" +nemo = """JPEG 2000 Signature Box (jP ) @ (0, 12) + Signature: 0d0a870a +File Type Box (ftyp) @ (12, 20) + Brand: jp2 + Compatibility: ['jp2 '] +JP2 Header Box (jp2h) @ (32, 45) + Image Header Box (ihdr) @ (40, 22) + Size: [1456 2592 3] + Bitdepth: 8 + Signed: False + Compression: wavelet + Colorspace Unknown: False + Colour Specification Box (colr) @ (62, 15) + Method: enumerated colorspace + Precedence: 0 + Colorspace: sRGB +UUID Box (uuid) @ (77, 3146) + UUID: be7acfcb-97a9-42e8-9c71-999491e3afac (XMP) + UUID Data: + + + + + Google + 2013-02-09T14:47:53 + + + 1 + 72/1 + 72/1 + 2 + HTC + HTC Glacier + 2592 + 1456 + + + 8 + 8 + 8 + + + 2 + 3 + + + 1343036288/4294967295 + 1413044224/4294967295 + + + + + 2748779008/4294967295 + 1417339264/4294967295 + 1288490240/4294967295 + 2576980480/4294967295 + 644245120/4294967295 + 257698032/4294967295 + + + + + 1 + 2528 + 1424 + 353/100 + 0 + 0/1 + WGS-84 + 2013-02-09T14:47:53 + + + 76 + + + 0220 + 0100 + + + 1 + 2 + 3 + 0 + + + 42,20.56N + 71,5.29W + 2013-02-09T19:47:53Z + NETWORK + + + 2013-02-09T14:47:53 + + + + + Glymur + Python XMP Toolkit + + + + + + +Contiguous Codestream Box (jp2c) @ (3223, 1132296) + SOC marker segment @ (3231, 0) + SIZ marker segment @ (3233, 47) + Profile: no profile + Reference Grid Height, Width: (1456 x 2592) + Vertical, Horizontal Reference Grid Offset: (0 x 0) + Reference Tile Height, Width: (1456 x 2592) + Vertical, Horizontal Reference Tile Offset: (0 x 0) + Bitdepth: (8, 8, 8) + Signed: (False, False, False) + Vertical, Horizontal Subsampling: ((1, 1), (1, 1), (1, 1)) + COD marker segment @ (3282, 12) + Coding style: + Entropy coder, without partitions + SOP marker segments: False + EPH marker segments: False + Coding style parameters: + Progression order: LRCP + Number of layers: 2 + Multiple component transformation usage: reversible + Number of resolutions: 2 + Code block height, width: (64 x 64) + Wavelet transform: 5-3 reversible + Precinct size: default, 2^15 x 2^15 + Code block context: + Selective arithmetic coding bypass: False + Reset context probabilities on coding pass boundaries: False + Termination on each coding pass: False + Vertically stripe causal context: False + Predictable termination: False + Segmentation symbols: False + QCD marker segment @ (3296, 7) + Quantization style: no quantization, 2 guard bits + Step size: [(0, 8), (0, 9), (0, 9), (0, 10)] + CME marker segment @ (3305, 37) + "Created by OpenJPEG version 2.0.0" + SOT marker segment @ (3344, 10) + Tile part index: 0 + Tile part length: 1132173 + Tile part instance: 0 + Number of tile parts: 1 + COC marker segment @ (3356, 9) + Associated component: 1 + Coding style for this component: Entropy coder, PARTITION = 0 + Coding style parameters: + Number of resolutions: 2 + Code block height, width: (64 x 64) + Wavelet transform: 5-3 reversible + Code block context: + Selective arithmetic coding bypass: False + Reset context probabilities on coding pass boundaries: False + Termination on each coding pass: False + Vertically stripe causal context: False + Predictable termination: False + Segmentation symbols: False + QCC marker segment @ (3367, 8) + Associated Component: 1 + Quantization style: no quantization, 2 guard bits + Step size: [(0, 8), (0, 9), (0, 9), (0, 10)] + COC marker segment @ (3377, 9) + Associated component: 2 + Coding style for this component: Entropy coder, PARTITION = 0 + Coding style parameters: + Number of resolutions: 2 + Code block height, width: (64 x 64) + Wavelet transform: 5-3 reversible + Code block context: + Selective arithmetic coding bypass: False + Reset context probabilities on coding pass boundaries: False + Termination on each coding pass: False + Vertically stripe causal context: False + Predictable termination: False + Segmentation symbols: False + QCC marker segment @ (3388, 8) + Associated Component: 2 + Quantization style: no quantization, 2 guard bits + Step size: [(0, 8), (0, 9), (0, 9), (0, 10)] + SOD marker segment @ (3398, 0) + EOC marker segment @ (1135517, 0)""" + # Output of reader requirements printing for text_GBR.jp2 text_GBR_rreq = r"""Reader Requirements Box (rreq) @ (40, 109) Fully Understands Aspect Mask: 0xffff @@ -580,7 +927,7 @@ issue_183_colr = """Colour Specification Box (colr) @ (62, 12) Method: restricted ICC profile Precedence: 0 ICC Profile: None""" - + # Progression order is invalid. issue_186_progression_order = """COD marker segment @ (174, 12) @@ -633,7 +980,7 @@ number_list_box = r"""Number List Box (nlst) @ (-1, 0) Association[2]: compositing layer 0""" -goodstuff = r"""Codestream: +goodstuff_codestream_header = r"""Codestream: SOC marker segment @ (0, 0) SIZ marker segment @ (2, 47) Profile: no profile @@ -668,3 +1015,80 @@ goodstuff = r"""Codestream: Quantization style: no quantization, 2 guard bits Step size: [(0, 8), (0, 9), (0, 9), (0, 10), (0, 9), (0, 9), (0, 10), (0, 9), (0, 9), (0, 10), (0, 9), (0, 9), (0, 10), (0, 9), (0, 9), (0, 10)]""" +goodstuff_with_full_header = r"""Codestream: + SOC marker segment @ (0, 0) + SIZ marker segment @ (2, 47) + Profile: no profile + Reference Grid Height, Width: (800 x 480) + Vertical, Horizontal Reference Grid Offset: (0 x 0) + Reference Tile Height, Width: (800 x 480) + Vertical, Horizontal Reference Tile Offset: (0 x 0) + Bitdepth: (8, 8, 8) + Signed: (False, False, False) + Vertical, Horizontal Subsampling: ((1, 1), (1, 1), (1, 1)) + COD marker segment @ (51, 12) + Coding style: + Entropy coder, without partitions + SOP marker segments: False + EPH marker segments: False + Coding style parameters: + Progression order: LRCP + Number of layers: 1 + Multiple component transformation usage: reversible + Number of resolutions: 6 + Code block height, width: (64 x 64) + Wavelet transform: 5-3 reversible + Precinct size: default, 2^15 x 2^15 + Code block context: + Selective arithmetic coding bypass: False + Reset context probabilities on coding pass boundaries: False + Termination on each coding pass: False + Vertically stripe causal context: False + Predictable termination: False + Segmentation symbols: False + QCD marker segment @ (65, 19) + Quantization style: no quantization, 2 guard bits + Step size: [(0, 8), (0, 9), (0, 9), (0, 10), (0, 9), (0, 9), (0, 10), (0, 9), (0, 9), (0, 10), (0, 9), (0, 9), (0, 10), (0, 9), (0, 9), (0, 10)] + SOT marker segment @ (86, 10) + Tile part index: 0 + Tile part length: 115132 + Tile part instance: 0 + Number of tile parts: 1 + COC marker segment @ (98, 9) + Associated component: 1 + Coding style for this component: Entropy coder, PARTITION = 0 + Coding style parameters: + Number of resolutions: 6 + Code block height, width: (64 x 64) + Wavelet transform: 5-3 reversible + Code block context: + Selective arithmetic coding bypass: False + Reset context probabilities on coding pass boundaries: False + Termination on each coding pass: False + Vertically stripe causal context: False + Predictable termination: False + Segmentation symbols: False + QCC marker segment @ (109, 20) + Associated Component: 1 + Quantization style: no quantization, 2 guard bits + Step size: [(0, 8), (0, 9), (0, 9), (0, 10), (0, 9), (0, 9), (0, 10), (0, 9), (0, 9), (0, 10), (0, 9), (0, 9), (0, 10), (0, 9), (0, 9), (0, 10)] + COC marker segment @ (131, 9) + Associated component: 2 + Coding style for this component: Entropy coder, PARTITION = 0 + Coding style parameters: + Number of resolutions: 6 + Code block height, width: (64 x 64) + Wavelet transform: 5-3 reversible + Code block context: + Selective arithmetic coding bypass: False + Reset context probabilities on coding pass boundaries: False + Termination on each coding pass: False + Vertically stripe causal context: False + Predictable termination: False + Segmentation symbols: False + QCC marker segment @ (142, 20) + Associated Component: 2 + Quantization style: no quantization, 2 guard bits + Step size: [(0, 8), (0, 9), (0, 9), (0, 10), (0, 9), (0, 9), (0, 10), (0, 9), (0, 9), (0, 10), (0, 9), (0, 9), (0, 10), (0, 9), (0, 9), (0, 10)] + SOD marker segment @ (164, 0) + EOC marker segment @ (115218, 0)""" diff --git a/glymur/test/test_callbacks.py b/glymur/test/test_callbacks.py index 5b6bd74..cc30de8 100644 --- a/glymur/test/test_callbacks.py +++ b/glymur/test/test_callbacks.py @@ -1,17 +1,10 @@ """ Test suite for openjpeg's callback functions. """ -# R0904: Seems like pylint is fooled in this situation -# pylint: disable=R0904 - -# 'mock' most certainly is in unittest (Python 3.3) -# pylint: disable=E0611,F0401 - import os import re import sys import tempfile -import warnings import unittest @@ -24,9 +17,9 @@ else: import glymur +from .fixtures import WARNING_INFRASTRUCTURE_ISSUE, WARNING_INFRASTRUCTURE_MSG + -@unittest.skipIf(glymur.lib.openjp2.OPENJP2 is None, - "Missing openjp2 library.") class TestCallbacks(unittest.TestCase): """Test suite for callbacks.""" @@ -37,68 +30,60 @@ class TestCallbacks(unittest.TestCase): def tearDown(self): pass + @unittest.skipIf(glymur.version.openjpeg_version[0] != '2', + "Missing openjp2 library.") + @unittest.skipIf(WARNING_INFRASTRUCTURE_ISSUE, WARNING_INFRASTRUCTURE_MSG) + @unittest.skipIf(os.name == "nt", "Temporary file issue on window.") + def test_info_callback_on_write_backwards_compatibility(self): + """Verify messages printed when writing an image in verbose mode.""" + j = glymur.Jp2k(self.jp2file) + with self.assertWarns(UserWarning): + tiledata = j.read(tile=0) + with tempfile.NamedTemporaryFile(suffix='.jp2') as tfile: + with patch('sys.stdout', new=StringIO()) as fake_out: + glymur.Jp2k(tfile.name, data=tiledata, verbose=True) + actual = fake_out.getvalue().strip() + expected = '[INFO] tile number 1 / 1' + self.assertEqual(actual, expected) + + @unittest.skipIf(glymur.version.openjpeg_version[0] != '2', + "Missing openjp2 library.") @unittest.skipIf(os.name == "nt", "Temporary file issue on window.") def test_info_callback_on_write(self): """Verify messages printed when writing an image in verbose mode.""" j = glymur.Jp2k(self.jp2file) - with warnings.catch_warnings(): - warnings.simplefilter("ignore") - tiledata = j.read(tile=0) + tiledata = j[:] with tempfile.NamedTemporaryFile(suffix='.jp2') as tfile: - j = glymur.Jp2k(tfile.name, 'wb') with patch('sys.stdout', new=StringIO()) as fake_out: - j.write(tiledata, verbose=True) + glymur.Jp2k(tfile.name, data=tiledata, verbose=True) actual = fake_out.getvalue().strip() expected = '[INFO] tile number 1 / 1' self.assertEqual(actual, expected) + @unittest.skipIf(glymur.version.openjpeg_version[0] == '0', + "Missing openjpeg/openjp2 library.") def test_info_callbacks_on_read(self): """stdio output when info callback handler is enabled""" # Verify that we get the expected stdio output when our internal info # callback handler is enabled. - j = glymur.Jp2k(self.j2kfile) + jp2 = glymur.Jp2k(self.j2kfile) with patch('sys.stdout', new=StringIO()) as fake_out: - j.read(rlevel=1, verbose=True, area=(0, 0, 200, 150)) + jp2.verbose = True + jp2[::2, ::2] actual = fake_out.getvalue().strip() - lines = ['[INFO] Start to read j2k main header (0).', - '[INFO] Main header has been correctly decoded.', - '[INFO] Setting decoding area to 0,0,150,200', - '[INFO] Header of tile 0 / 0 has been read.', - '[INFO] Tile 1/1 has been decoded.', - '[INFO] Image data has been updated with tile 1.'] - - expected = '\n'.join(lines) - self.assertEqual(actual, expected) - - -@unittest.skipIf(glymur.lib.openjpeg.OPENJPEG is None, - "Missing openjpeg library.") -class TestCallbacks15(unittest.TestCase): - """This test suite is for OpenJPEG 1.5.1 properties. - """ - - def setUp(self): - self.jp2file = glymur.data.nemo() - self.j2kfile = glymur.data.goodstuff() - - def tearDown(self): - pass - - def test_info_callbacks_on_read(self): - """Verify stdout when reading. - - Verify that we get the expected stdio output when our internal info - callback handler is enabled. - """ - with patch('glymur.lib.openjp2.OPENJP2', new=None): - # Force to use OPENJPEG instead of OPENJP2. - j = glymur.Jp2k(self.j2kfile) - with patch('sys.stdout', new=StringIO()) as fake_out: - j.read(rlevel=1, verbose=True) - actual = fake_out.getvalue().strip() + if glymur.version.openjpeg_version[0] == '2': + lines = ['[INFO] Start to read j2k main header (0).', + '[INFO] Main header has been correctly decoded.', + '[INFO] Setting decoding area to 0,0,480,800', + '[INFO] Header of tile 0 / 0 has been read.', + '[INFO] Tile 1/1 has been decoded.', + '[INFO] Image data has been updated with tile 1.'] + expected = '\n'.join(lines) + self.assertEqual(actual, expected) + else: regex = re.compile(r"""\[INFO\]\stile\s1\sof\s1\s+ \[INFO\]\s-\stiers-1\stook\s [0-9]+\.[0-9]+\ss\s+ @@ -108,13 +93,7 @@ class TestCallbacks15(unittest.TestCase): [0-9]+\.[0-9]+\ss""", re.VERBOSE) - # assertRegex in Python 3.3 (python2.7/pylint issue) - # pylint: disable=E1101 if sys.hexversion <= 0x03020000: self.assertRegexpMatches(actual, regex) else: self.assertRegex(actual, regex) - - -if __name__ == "__main__": - unittest.main() diff --git a/glymur/test/test_codestream.py b/glymur/test/test_codestream.py deleted file mode 100644 index abea7e2..0000000 --- a/glymur/test/test_codestream.py +++ /dev/null @@ -1,153 +0,0 @@ -""" -Test suite for codestream parsing. -""" - -# unittest doesn't work well with R0904. -# pylint: disable=R0904 - -# tempfile.TemporaryDirectory, unittest.assertWarns introduced in 3.2 -# pylint: disable=E1101 - -import os -import struct -import sys -import tempfile -import unittest -import warnings - -from glymur import Jp2k -import glymur - -from .fixtures import opj_data_file, OPJ_DATA_ROOT - -class TestCodestream(unittest.TestCase): - """Test suite for unusual codestream cases.""" - - def setUp(self): - self.jp2file = glymur.data.nemo() - - def tearDown(self): - pass - - def test_siz_segment_ssiz_unsigned(self): - """ssiz attribute to be removed in future release""" - j = Jp2k(self.jp2file) - codestream = j.get_codestream() - - # The ssiz attribute was simply a tuple of raw bytes. - # The first 7 bits are interpreted as the bitdepth, the MSB determines - # whether or not it is signed. - self.assertEqual(codestream.segment[1].ssiz, (7, 7, 7)) - - -@unittest.skipIf(OPJ_DATA_ROOT is None, - "OPJ_DATA_ROOT environment variable not set") -class TestCodestreamOpjData(unittest.TestCase): - """Test suite for unusual codestream cases. Uses OPJ_DATA_ROOT""" - - def setUp(self): - self.jp2file = glymur.data.nemo() - - def tearDown(self): - pass - - @unittest.skipIf(os.name == "nt", "Temporary file issue on window.") - def test_reserved_marker_segment(self): - """Reserved marker segments are ok.""" - - # Some marker segments were reserved in FCD15444-1. Since that - # standard is old, some of them may have come into use. - # - # Let's inject a reserved marker segment into a file that - # we know something about to make sure we can still parse it. - filename = os.path.join(OPJ_DATA_ROOT, 'input/conformance/p0_01.j2k') - with tempfile.NamedTemporaryFile(suffix='.j2k') as tfile: - with open(filename, 'rb') as ifile: - # Everything up until the first QCD marker. - read_buffer = ifile.read(45) - tfile.write(read_buffer) - - # Write the new marker segment, 0xff6f = 65391 - read_buffer = struct.pack('>HHB', int(65391), int(3), int(0)) - tfile.write(read_buffer) - - # Get the rest of the input file. - read_buffer = ifile.read() - tfile.write(read_buffer) - tfile.flush() - - codestream = Jp2k(tfile.name).get_codestream() - - self.assertEqual(codestream.segment[2].marker_id, '0xff6f') - self.assertEqual(codestream.segment[2].length, 3) - self.assertEqual(codestream.segment[2].data, b'\x00') - - def test_psot_is_zero(self): - """Psot=0 in SOT is perfectly legal. Issue #78.""" - filename = os.path.join(OPJ_DATA_ROOT, - 'input/nonregression/123.j2c') - j = Jp2k(filename) - codestream = j.get_codestream(header_only=False) - - # The codestream is valid, so we should be able to get the entire - # codestream, so the last one is EOC. - self.assertEqual(codestream.segment[-1].marker_id, 'EOC') - - - def test_siz_segment_ssiz_signed(self): - """ssiz attribute to be removed in future release""" - filename = os.path.join(OPJ_DATA_ROOT, 'input/conformance/p0_03.j2k') - j = Jp2k(filename) - codestream = j.get_codestream() - - # The ssiz attribute was simply a tuple of raw bytes. - # The first 7 bits are interpreted as the bitdepth, the MSB determines - # whether or not it is signed. - self.assertEqual(codestream.segment[1].ssiz, (131,)) - - -class TestCodestreamRepr(unittest.TestCase): - - def setUp(self): - self.jp2file = glymur.data.nemo() - - def tearDown(self): - pass - - def test_soc(self): - """Test SOC segment repr""" - segment = glymur.codestream.SOCsegment() - newseg = eval(repr(segment)) - self.assertEqual(newseg.marker_id, 'SOC') - - def test_siz(self): - """Test SIZ segment repr""" - kwargs = {'rsiz': 0, - 'xysiz': (2592, 1456), - 'xyosiz': (0, 0), - 'xytsiz': (2592, 1456), - 'xytosiz': (0, 0), - 'Csiz': 3, - 'bitdepth': (8, 8, 8), - 'signed': (False, False, False), - 'xyrsiz': ((1, 1, 1), (1, 1, 1))} - segment = glymur.codestream.SIZsegment(**kwargs) - newseg = eval(repr(segment)) - self.assertEqual(newseg.marker_id, 'SIZ') - self.assertEqual(newseg.xsiz, 2592) - self.assertEqual(newseg.ysiz, 1456) - self.assertEqual(newseg.xosiz, 0) - self.assertEqual(newseg.yosiz, 0) - self.assertEqual(newseg.xtsiz, 2592) - self.assertEqual(newseg.ytsiz, 1456) - self.assertEqual(newseg.xtosiz, 0) - self.assertEqual(newseg.ytosiz, 0) - - self.assertEqual(newseg.xrsiz, (1, 1, 1)) - self.assertEqual(newseg.yrsiz, (1, 1, 1)) - self.assertEqual(newseg.bitdepth, (8, 8, 8)) - self.assertEqual(newseg.signed, (False, False, False)) - - -if __name__ == "__main__": - unittest.main() diff --git a/glymur/test/test_codestream_warnings.py b/glymur/test/test_codestream_warnings.py deleted file mode 100644 index 8b50bf2..0000000 --- a/glymur/test/test_codestream_warnings.py +++ /dev/null @@ -1,100 +0,0 @@ -""" -Test suite for codestream parsing. -""" - -# unittest doesn't work well with R0904. -# pylint: disable=R0904 - -# tempfile.TemporaryDirectory, unittest.assertWarns introduced in 3.2 -# pylint: disable=E1101 - -import os -import struct -import sys -import tempfile -import unittest -import warnings - -from glymur import Jp2k -import glymur - -from .fixtures import opj_data_file, OPJ_DATA_ROOT - -@unittest.skipIf(sys.platform.startswith('linux'), 'warnings failing on linux') -@unittest.skipIf(OPJ_DATA_ROOT is None, - "OPJ_DATA_ROOT environment variable not set") -class TestCodestreamOpjDataWarnings(unittest.TestCase): - """Test suite for unusual codestream cases. Uses OPJ_DATA_ROOT""" - - def test_bad_rsiz(self): - """Should warn if RSIZ is bad. Issue196""" - filename = opj_data_file('input/nonregression/edf_c2_1002767.jp2') - with warnings.catch_warnings(record=True) as w: - warnings.simplefilter('always') - j = Jp2k(filename) - self.assertEqual(len(w), 3) - self.assertTrue(issubclass(w[0].category, UserWarning)) - self.assertTrue('Invalid profile' in str(w[0].message)) - - def test_bad_wavelet_transform(self): - """Should warn if wavelet transform is bad. Issue195""" - filename = opj_data_file('input/nonregression/edf_c2_10025.jp2') - with warnings.catch_warnings(record=True) as w: - warnings.simplefilter('always') - j = Jp2k(filename) - self.assertTrue(issubclass(w[0].category, UserWarning)) - self.assertTrue('Invalid wavelet transform' in str(w[0].message)) - - def test_invalid_progression_order(self): - """Should still be able to parse even if prog order is invalid.""" - jfile = opj_data_file('input/nonregression/2977.pdf.asan.67.2198.jp2') - with warnings.catch_warnings(record=True) as w: - warnings.simplefilter('always') - Jp2k(jfile) - self.assertTrue(issubclass(w[0].category, UserWarning)) - self.assertTrue('Invalid progression order' in str(w[0].message)) - - def test_tile_height_is_zero(self): - """Zero tile height should not cause an exception.""" - filename = opj_data_file('input/nonregression/2539.pdf.SIGFPE.706.1712.jp2') - with warnings.catch_warnings(record=True) as w: - warnings.simplefilter('always') - Jp2k(filename) - self.assertTrue(issubclass(w[0].category, UserWarning)) - self.assertTrue('Invalid tile dimensions' in str(w[0].message)) - - @unittest.skipIf(os.name == "nt", "Temporary file issue on window.") - def test_unknown_marker_segment(self): - """Should warn for an unknown marker.""" - # Let's inject a marker segment whose marker does not appear to - # be valid. We still parse the file, but warn about the offending - # marker. - filename = os.path.join(OPJ_DATA_ROOT, 'input/conformance/p0_01.j2k') - with tempfile.NamedTemporaryFile(suffix='.j2k') as tfile: - with open(filename, 'rb') as ifile: - # Everything up until the first QCD marker. - read_buffer = ifile.read(45) - tfile.write(read_buffer) - - # Write the new marker segment, 0xff79 = 65401 - read_buffer = struct.pack('>HHB', int(65401), int(3), int(0)) - tfile.write(read_buffer) - - # Get the rest of the input file. - read_buffer = ifile.read() - tfile.write(read_buffer) - tfile.flush() - - with warnings.catch_warnings(record=True) as w: - warnings.simplefilter('always') - codestream = Jp2k(tfile.name).get_codestream() - self.assertTrue(issubclass(w[0].category, UserWarning)) - self.assertTrue('Unrecognized marker' in str(w[0].message)) - - self.assertEqual(codestream.segment[2].marker_id, '0xff79') - self.assertEqual(codestream.segment[2].length, 3) - self.assertEqual(codestream.segment[2].data, b'\x00') - - -if __name__ == "__main__": - unittest.main() diff --git a/glymur/test/test_config.py b/glymur/test/test_config.py index b8c97ae..59a8ef3 100644 --- a/glymur/test/test_config.py +++ b/glymur/test/test_config.py @@ -1,22 +1,13 @@ """These tests are for edge cases where OPENJPEG does not exist, but OPENJP2 may be present in some form or other. """ -# unittest doesn't work well with R0904. -# pylint: disable=R0904 - -# tempfile.TemporaryDirectory, unittest.assertWarns introduced in 3.2 -# pylint: disable=E1101 - -# unittest.mock only in Python 3.3 (python2.7/pylint import issue) -# pylint: disable=E0611,F0401 - - +import contextlib +import ctypes import imp import os import sys import tempfile import unittest -import warnings if sys.hexversion <= 0x03030000: from mock import patch @@ -26,6 +17,43 @@ else: import glymur from glymur import Jp2k +from .fixtures import (WARNING_INFRASTRUCTURE_ISSUE, + WARNING_INFRASTRUCTURE_MSG, + WINDOWS_TMP_FILE_MSG) + + +def openjpeg_not_found_by_ctypes(): + """ + Need to know if openjpeg library can be picked right up by ctypes for one + of the tests. + """ + with patch.dict('os.environ', + {'DYLD_FALLBACK_LIBRARY_PATH': '/opt/local/lib'}): + if ctypes.util.find_library('openjpeg') is None: + return True + else: + return False + + +@contextlib.contextmanager +def chdir(dirname=None): + """ + This context manager restores the value of the current working directory + (cwd) after the enclosed code block completes or raises an exception. If a + directory name is supplied to the context manager then the cwd is changed + prior to running the code block. + + Shamelessly lifted from + http://www.astropython.org/snippet/2009/10/chdir-context-manager + """ + curdir = os.getcwd() + try: + if dirname is not None: + os.chdir(dirname) + yield + finally: + os.chdir(curdir) + @unittest.skipIf(sys.hexversion < 0x03020000, "TemporaryDirectory introduced in 3.2.") @@ -61,7 +89,6 @@ class TestSuite(unittest.TestCase): # Need to reliably recover the location of the openjp2 library, # so using '_name' appears to be the only way to do it. - # pylint: disable=W0212 libloc = glymur.lib.openjp2.OPENJP2._name line = 'openjp2: {0}\n'.format(libloc) tfile.write(line) @@ -70,6 +97,8 @@ class TestSuite(unittest.TestCase): imp.reload(glymur.lib.openjp2) Jp2k(self.jp2file) + @unittest.skipIf(WARNING_INFRASTRUCTURE_ISSUE, WARNING_INFRASTRUCTURE_MSG) + @unittest.skipIf(os.name == "nt", WINDOWS_TMP_FILE_MSG) def test_xdg_env_config_file_is_bad(self): """A non-existant library location should be rejected.""" with tempfile.TemporaryDirectory() as tdir: @@ -84,56 +113,60 @@ class TestSuite(unittest.TestCase): with patch.dict('os.environ', {'XDG_CONFIG_HOME': tdir}): # Misconfigured new configuration file should # be rejected. - with warnings.catch_warnings(record=True) as w: - warnings.simplefilter('always') + regex = 'could not be loaded' + with self.assertWarnsRegex(UserWarning, regex): imp.reload(glymur.lib.openjp2) - self.assertTrue(issubclass(w[0].category,UserWarning)) - self.assertTrue('could not be loaded' in str(w[0].message)) + @unittest.skipIf(glymur.lib.openjp2.OPENJPEG is None, + "Needs openjp2 and openjpeg before this test make sense.") + @unittest.skipIf(os.name == "nt", WINDOWS_TMP_FILE_MSG) + def test_library_specified_as_None(self): + """Verify that we can stop library from being loaded by using None.""" + with tempfile.TemporaryDirectory() as tdir: + configdir = os.path.join(tdir, 'glymur') + os.mkdir(configdir) + fname = os.path.join(configdir, 'glymurrc') + with open(fname, 'w') as fptr: + # Essentially comment out openjp2 and preferentially load + # openjpeg instead. + fptr.write('[library]\n') + fptr.write('openjp2: None\n') + msg = 'openjpeg: {0}\n' + msg = msg.format(glymur.lib.openjp2.OPENJPEG._name) + fptr.write(msg) + fptr.flush() + with patch.dict('os.environ', {'XDG_CONFIG_HOME': tdir}): + imp.reload(glymur.lib.openjp2) + self.assertIsNone(glymur.lib.openjp2.OPENJP2) + self.assertIsNotNone(glymur.lib.openjp2.OPENJPEG) -@unittest.skipIf(glymur.lib.openjp2.OPENJP2 is None and - glymur.lib.openjpeg.OPENJPEG is None, - "Missing openjp2 library.") -class TestConfig(unittest.TestCase): - """Test suite for reading without proper library in place.""" + @unittest.skipIf(glymur.lib.openjp2.OPENJPEG is None, + "Needs openjpeg before this test make sense.") + @unittest.skipIf(openjpeg_not_found_by_ctypes(), + "OpenJPEG must be found before this test can work.") + @unittest.skipIf(os.name == "nt", WINDOWS_TMP_FILE_MSG) + def test_config_dir_but_no_config_file(self): - def setUp(self): - self.jp2file = glymur.data.nemo() - self.j2kfile = glymur.data.goodstuff() + with tempfile.TemporaryDirectory() as tdir: + configdir = os.path.join(tdir, 'glymur') + os.mkdir(configdir) + with patch.dict('os.environ', {'XDG_CONFIG_HOME': tdir}): + # Should still be able to load openjpeg, despite the + # configuration file not being there + imp.reload(glymur.lib.openjpeg) + self.assertIsNotNone(glymur.lib.openjp2.OPENJPEG) - def tearDown(self): - pass - - def test_read_without_library(self): - """Don't have either openjp2 or openjpeg libraries? Must error out. - """ - with patch('glymur.lib.openjp2.OPENJP2', new=None): - with patch('glymur.lib.openjpeg.OPENJPEG', new=None): - with self.assertRaises(glymur.jp2k.LibraryNotFoundError): - glymur.Jp2k(self.jp2file).read() - - def test_read_bands_without_library(self): - """Don't have openjp2 library? Must error out. - """ - with patch('glymur.lib.openjp2.OPENJP2', new=None): - with patch('glymur.lib.openjpeg.OPENJPEG', new=None): - with patch('glymur.version.openjpeg_version_tuple', - new=(0, 0, 0)): - with self.assertRaises(glymur.jp2k.LibraryNotFoundError): - glymur.Jp2k(self.jp2file).read_bands() - - @unittest.skipIf(os.name == "nt", "NamedTemporaryFile issue on windows") - def test_write_without_library(self): - """Don't have openjpeg libraries? Must error out. - """ - data = glymur.Jp2k(self.j2kfile).read() - with patch('glymur.lib.openjp2.OPENJP2', new=None): - with patch('glymur.lib.openjpeg.OPENJPEG', new=None): - with self.assertRaises(glymur.jp2k.LibraryNotFoundError): - with tempfile.NamedTemporaryFile(suffix='.jp2') as tfile: - ofile = Jp2k(tfile.name, 'wb') - ofile.write(data) - - -if __name__ == "__main__": - unittest.main() + @unittest.skipIf(os.name == "nt", WINDOWS_TMP_FILE_MSG) + def test_config_file_in_current_directory(self): + """A configuration file in the current directory should be honored.""" + libloc = glymur.lib.openjp2.OPENJP2._name + with tempfile.TemporaryDirectory() as tdir1: + fname = os.path.join(tdir1, 'glymurrc') + with open(fname, 'w') as fptr: + fptr.write('[library]\n') + fptr.write('openjp2: {0}\n'.format(libloc)) + fptr.flush() + with chdir(tdir1): + # Should be able to load openjp2 as before. + imp.reload(glymur.lib.openjp2) + self.assertEqual(glymur.lib.openjp2.OPENJP2._name, libloc) diff --git a/glymur/test/test_glymur_warnings.py b/glymur/test/test_glymur_warnings.py new file mode 100644 index 0000000..8086004 --- /dev/null +++ b/glymur/test/test_glymur_warnings.py @@ -0,0 +1,164 @@ +""" +Test suite for warnings issued by glymur. +""" +import os +import re +import struct +import tempfile +import unittest + +from glymur import Jp2k +import glymur + +from .fixtures import opj_data_file, OPJ_DATA_ROOT +from .fixtures import WARNING_INFRASTRUCTURE_ISSUE, WARNING_INFRASTRUCTURE_MSG + + +@unittest.skipIf(OPJ_DATA_ROOT is None, + "OPJ_DATA_ROOT environment variable not set") +@unittest.skipIf(WARNING_INFRASTRUCTURE_ISSUE, WARNING_INFRASTRUCTURE_MSG) +class TestWarnings(unittest.TestCase): + """Test suite for warnings issued by glymur.""" + + def test_invalid_compatibility_list_entry(self): + """should not error out with invalid compatibility list entry""" + filename = opj_data_file('input/nonregression/issue397.jp2') + with self.assertWarns(UserWarning): + Jp2k(filename) + self.assertTrue(True) + + def test_exceeded_box_length(self): + """ + should warn if reading past end of a box + + Verify that a warning is issued if we read past the end of a box + This file has a palette (pclr) box whose length is impossibly + short. + """ + infile = os.path.join(OPJ_DATA_ROOT, + 'input/nonregression/mem-b2ace68c-1381.jp2') + regex = re.compile(r'''Encountered\san\sunrecoverable\sValueError\s + while\sparsing\sa\sPalette\sbox\sat\sbyte\s + offset\s\d+\.\s+The\soriginal\serror\smessage\s + was\s"total\ssize\sof\snew\sarray\smust\sbe\s + unchanged"''', + re.VERBOSE) + with self.assertWarnsRegex(UserWarning, regex): + Jp2k(infile) + + def test_NR_DEC_issue188_beach_64bitsbox_jp2_41_decode(self): + """ + Has an 'XML ' box instead of 'xml '. Yes that is pedantic, but it + really does deserve a warning. + """ + relpath = 'input/nonregression/issue188_beach_64bitsbox.jp2' + jfile = opj_data_file(relpath) + pattern = r"""Unrecognized\sbox\s\(b'XML\s'\)\sencountered.""" + regex = re.compile(pattern, re.VERBOSE) + with self.assertWarnsRegex(UserWarning, regex): + Jp2k(jfile) + + def test_NR_gdal_fuzzer_unchecked_numresolutions_dump(self): + """ + Has an invalid number of resolutions. + """ + lst = ['input', 'nonregression', + 'gdal_fuzzer_unchecked_numresolutions.jp2'] + jfile = opj_data_file('/'.join(lst)) + regex = re.compile(r"""Invalid\snumber\sof\sresolutions\s + \(\d+\)\.""", + re.VERBOSE) + with self.assertWarnsRegex(UserWarning, regex): + Jp2k(jfile).get_codestream() + + @unittest.skipIf(re.match("1.5|2.0.0", glymur.version.openjpeg_version), + "Test not passing on 1.5.x, not introduced until 2.x") + def test_NR_gdal_fuzzer_check_number_of_tiles(self): + """ + Has an impossible tiling setup. + """ + lst = ['input', 'nonregression', + 'gdal_fuzzer_check_number_of_tiles.jp2'] + jfile = opj_data_file('/'.join(lst)) + regex = re.compile(r"""Invalid\snumber\sof\stiles\s + \(\d+\)\.""", + re.VERBOSE) + with self.assertWarnsRegex(UserWarning, regex): + Jp2k(jfile).get_codestream() + + def test_NR_gdal_fuzzer_check_comp_dx_dy_jp2_dump(self): + """ + Invalid subsampling value. + """ + lst = ['input', 'nonregression', 'gdal_fuzzer_check_comp_dx_dy.jp2'] + jfile = opj_data_file('/'.join(lst)) + regex = re.compile(r"""Invalid\ssubsampling\svalue\sfor\scomponent\s + \d+:\s+ + dx=\d+,\s*dy=\d+""", + re.VERBOSE) + with self.assertWarnsRegex(UserWarning, regex): + Jp2k(jfile).get_codestream() + + def test_NR_gdal_fuzzer_assert_in_opj_j2k_read_SQcd_SQcc_patch_jp2(self): + lst = ['input', 'nonregression', + 'gdal_fuzzer_assert_in_opj_j2k_read_SQcd_SQcc.patch.jp2'] + jfile = opj_data_file('/'.join(lst)) + regex = re.compile(r"""Invalid\scomponent\snumber\s\(\d+\),\s + number\sof\scomponents\sis\sonly\s\d+""", + re.VERBOSE) + with self.assertWarnsRegex(UserWarning, regex): + Jp2k(jfile).get_codestream() + + def test_bad_rsiz(self): + """Should warn if RSIZ is bad. Issue196""" + filename = opj_data_file('input/nonregression/edf_c2_1002767.jp2') + with self.assertWarnsRegex(UserWarning, 'Invalid profile'): + Jp2k(filename).get_codestream() + + def test_bad_wavelet_transform(self): + """Should warn if wavelet transform is bad. Issue195""" + filename = opj_data_file('input/nonregression/edf_c2_10025.jp2') + with self.assertWarnsRegex(UserWarning, 'Invalid wavelet transform'): + Jp2k(filename).get_codestream() + + def test_invalid_progression_order(self): + """Should still be able to parse even if prog order is invalid.""" + jfile = opj_data_file('input/nonregression/2977.pdf.asan.67.2198.jp2') + with self.assertWarnsRegex(UserWarning, 'Invalid progression order'): + Jp2k(jfile).get_codestream() + + def test_tile_height_is_zero(self): + """Zero tile height should not cause an exception.""" + filename = 'input/nonregression/2539.pdf.SIGFPE.706.1712.jp2' + filename = opj_data_file(filename) + with self.assertWarnsRegex(UserWarning, 'Invalid tile dimensions'): + Jp2k(filename).get_codestream() + + @unittest.skipIf(os.name == "nt", "Temporary file issue on window.") + def test_unknown_marker_segment(self): + """Should warn for an unknown marker.""" + # Let's inject a marker segment whose marker does not appear to + # be valid. We still parse the file, but warn about the offending + # marker. + filename = os.path.join(OPJ_DATA_ROOT, 'input/conformance/p0_01.j2k') + with tempfile.NamedTemporaryFile(suffix='.j2k') as tfile: + with open(filename, 'rb') as ifile: + # Everything up until the first QCD marker. + read_buffer = ifile.read(45) + tfile.write(read_buffer) + + # Write the new marker segment, 0xff79 = 65401 + read_buffer = struct.pack('>HHB', int(65401), int(3), int(0)) + tfile.write(read_buffer) + + # Get the rest of the input file. + read_buffer = ifile.read() + tfile.write(read_buffer) + tfile.flush() + + with self.assertWarnsRegex(UserWarning, 'Unrecognized marker'): + Jp2k(tfile.name).get_codestream() + + +if __name__ == "__main__": + unittest.main() diff --git a/glymur/test/test_icc.py b/glymur/test/test_icc.py index 734d557..e18775c 100644 --- a/glymur/test/test_icc.py +++ b/glymur/test/test_icc.py @@ -1,22 +1,17 @@ """ ICC profile tests. """ - -# unittest doesn't work well with R0904. -# pylint: disable=R0904 - import datetime -import os -import sys import unittest -import warnings import numpy as np from glymur import Jp2k from .fixtures import OPJ_DATA_ROOT, opj_data_file +from .fixtures import WARNING_INFRASTRUCTURE_ISSUE, WARNING_INFRASTRUCTURE_MSG +@unittest.skipIf(WARNING_INFRASTRUCTURE_ISSUE, WARNING_INFRASTRUCTURE_MSG) @unittest.skipIf(OPJ_DATA_ROOT is None, "OPJ_DATA_ROOT environment variable not set") class TestICC(unittest.TestCase): @@ -31,9 +26,8 @@ class TestICC(unittest.TestCase): def test_file5(self): """basic ICC profile""" filename = opj_data_file('input/conformance/file5.jp2') - with warnings.catch_warnings(): + with self.assertWarns(UserWarning): # The file has a bad compatibility list entry. Not important here. - warnings.simplefilter("ignore") j = Jp2k(filename) profile = j.box[3].box[1].icc_profile self.assertEqual(profile['Size'], 546) @@ -62,18 +56,10 @@ class TestICC(unittest.TestCase): self.assertEqual(profile['Creator'], 'JPEG') - @unittest.skipIf(sys.platform.startswith('linux'), 'Failing on linux') def test_invalid_profile_header(self): """invalid ICC header data should cause UserWarning""" jfile = opj_data_file('input/nonregression/orb-blue10-lin-jp2.jp2') - # assertWarns in Python 3.3 (python2.7/pylint issue) - # pylint: disable=E1101 - with warnings.catch_warnings(record=True) as w: - warnings.simplefilter('always') + regex = 'ICC profile header is corrupt' + with self.assertWarnsRegex(UserWarning, regex): Jp2k(jfile) - self.assertTrue(issubclass(w[0].category,UserWarning)) - self.assertTrue('ICC profile header is corrupt' in str(w[0].message)) - -if __name__ == "__main__": - unittest.main() diff --git a/glymur/test/test_jp2box.py b/glymur/test/test_jp2box.py index e0f12e2..f9e7c5c 100644 --- a/glymur/test/test_jp2box.py +++ b/glymur/test/test_jp2box.py @@ -1,18 +1,6 @@ """ Test suite specifically targeting JP2 box layout. """ -# E1103: return value from read may be list or np array -# pylint: disable=E1103 - -# R0902: More than 7 instance attributes are just fine for testing. -# pylint: disable=R0902 - -# R0904: Seems like pylint is fooled in this situation -# pylint: disable=R0904 - -# W0613: load_tests doesn't need to use ignore or loader arguments. -# pylint: disable=W0613 - import doctest import os import re @@ -20,10 +8,8 @@ import shutil import struct import sys import tempfile -import uuid from uuid import UUID import unittest -import warnings import lxml.etree as ET import numpy as np @@ -36,12 +22,13 @@ from glymur.jp2box import JPEG2000SignatureBox from glymur.core import COLOR, OPACITY from glymur.core import RED, GREEN, BLUE, GREY, WHOLE_IMAGE -from .fixtures import opj_data_file +from .fixtures import (WARNING_INFRASTRUCTURE_ISSUE, + WARNING_INFRASTRUCTURE_MSG, + WINDOWS_TMP_FILE_MSG, MetadataBase) -try: - FORMAT_CORPUS_DATA_ROOT = os.environ['FORMAT_CORPUS_DATA_ROOT'] -except KeyError: - FORMAT_CORPUS_DATA_ROOT = None + +def docTearDown(doctest_obj): + glymur.set_parseoptions(full_codestream=False) def load_tests(loader, tests, ignore): @@ -49,31 +36,35 @@ def load_tests(loader, tests, ignore): if os.name == "nt": # Can't do it on windows, temporary file issue. return tests - tests.addTests(doctest.DocTestSuite('glymur.jp2box')) + tests.addTests(doctest.DocTestSuite('glymur.jp2box', + tearDown=docTearDown)) return tests -@unittest.skipIf(os.name == "nt", "Temporary file issue on window.") + +@unittest.skipIf(os.name == "nt", WINDOWS_TMP_FILE_MSG) class TestDataEntryURL(unittest.TestCase): """Test suite for DataEntryURL boxes.""" def setUp(self): self.jp2file = glymur.data.nemo() + @unittest.skipIf(re.match("1.5|2", + glymur.version.openjpeg_version) is None, + "Must have openjpeg 1.5 or higher to run") def test_wrap_greyscale(self): """A single component should be wrapped as GREYSCALE.""" j = Jp2k(self.jp2file) - data = j.read() + data = j[:] red = data[:, :, 0] # Write it back out as a raw codestream. with tempfile.NamedTemporaryFile(suffix=".j2k") as tfile1: - j2k = glymur.Jp2k(tfile1.name, 'wb') - j2k.write(data[:, :, 0]) + j2k = glymur.Jp2k(tfile1.name, data=red) # Ok, now rewrap it as JP2. The colorspace should be GREYSCALE. with tempfile.NamedTemporaryFile(suffix=".jp2") as tfile2: jp2 = j2k.wrap(tfile2.name) self.assertEqual(jp2.box[2].box[1].colorspace, - glymur.core.GREYSCALE) + glymur.core.GREYSCALE) def test_basic_url(self): """Just your most basic URL box.""" @@ -95,7 +86,7 @@ class TestDataEntryURL(unittest.TestCase): self.assertEqual(jp22.box[4].url, url) def test_null_termination(self): - """I.9.3.2 specifies that the location field must be null terminated.""" + """I.9.3.2 specifies that location field must be null terminated.""" jp2 = Jp2k(self.jp2file) url = 'http://glymur.readthedocs.org' @@ -106,21 +97,24 @@ class TestDataEntryURL(unittest.TestCase): jp22 = jp2.wrap(tfile.name, boxes=boxes) self.assertEqual(jp22.box[-1].length, 42) - - # Go to the last box. Seek past the L, T, version, and flag fields. + + # Go to the last box. Seek past the L, T, version, + # and flag fields. with open(tfile.name, 'rb') as fptr: fptr.seek(jp22.box[-1].offset + 4 + 4 + 1 + 3) - - nbytes = jp22.box[-1].offset + jp22.box[-1].length - fptr.tell() + + nbytes = (jp22.box[-1].offset + + jp22.box[-1].length - + fptr.tell()) read_buffer = fptr.read(nbytes) read_url = read_buffer.decode('utf-8') self.assertEqual(url + chr(0), read_url) -@unittest.skipIf(re.match(r'''(1|2.0.0)''', +@unittest.skipIf(re.match(r'''0|1|2.0.0''', glymur.version.openjpeg_version) is not None, "Not supported until 2.1") -@unittest.skipIf(os.name == "nt", "Temporary file issue on window.") +@unittest.skipIf(os.name == "nt", WINDOWS_TMP_FILE_MSG) class TestChannelDefinition(unittest.TestCase): """Test suite for channel definition boxes.""" @@ -128,24 +122,21 @@ class TestChannelDefinition(unittest.TestCase): def setUpClass(cls): """Need a one_plane plane image for greyscale testing.""" j2k = Jp2k(glymur.data.goodstuff()) - data = j2k.read() + data = j2k[:] # Write the first component back out to file. with tempfile.NamedTemporaryFile(suffix=".j2k", delete=False) as tfile: - grey_j2k = Jp2k(tfile.name, 'wb') - grey_j2k.write(data[:, :, 0]) + Jp2k(tfile.name, data=data[:, :, 0]) cls.one_plane = tfile.name # Write the first two components back out to file. with tempfile.NamedTemporaryFile(suffix=".j2k", delete=False) as tfile: - grey_j2k = Jp2k(tfile.name, 'wb') - grey_j2k.write(data[:, :, 0:1]) + Jp2k(tfile.name, data=data[:, :, 0:1]) cls.two_planes = tfile.name # Write four components back out to file. with tempfile.NamedTemporaryFile(suffix=".j2k", delete=False) as tfile: - rgba_jp2 = Jp2k(tfile.name, 'wb') shape = (data.shape[0], data.shape[1], 1) alpha = np.zeros((shape), dtype=data.dtype) data4 = np.concatenate((data, alpha), axis=2) - rgba_jp2.write(data4) + Jp2k(tfile.name, data=data4) cls.four_planes = tfile.name @classmethod @@ -357,6 +348,7 @@ class TestChannelDefinition(unittest.TestCase): with self.assertRaises((IOError, OSError)): j2k.wrap(tfile.name, boxes=boxes) + @unittest.skipIf(WARNING_INFRASTRUCTURE_ISSUE, WARNING_INFRASTRUCTURE_MSG) def test_bad_type(self): """Channel types are limited to 0, 1, 2, 65535 Should reject if not all of index, channel_type, association the @@ -365,25 +357,20 @@ class TestChannelDefinition(unittest.TestCase): channel_type = (COLOR, COLOR, 3) association = (RED, GREEN, BLUE) - with warnings.catch_warnings(record=True) as w: - warnings.simplefilter('always') + with self.assertWarns(UserWarning): glymur.jp2box.ChannelDefinitionBox(channel_type=channel_type, association=association) - self.assertEqual(len(w), 1) - self.assertTrue(issubclass(w[0].category, UserWarning)) + @unittest.skipIf(WARNING_INFRASTRUCTURE_ISSUE, WARNING_INFRASTRUCTURE_MSG) def test_wrong_lengths(self): """Should reject if not all of index, channel_type, association the same length. """ channel_type = (COLOR, COLOR) association = (RED, GREEN, BLUE) - with warnings.catch_warnings(record=True) as w: - warnings.simplefilter('always') + with self.assertWarns(UserWarning): glymur.jp2box.ChannelDefinitionBox(channel_type=channel_type, association=association) - self.assertEqual(len(w), 1) - self.assertTrue(issubclass(w[0].category, UserWarning)) class TestFileTypeBox(unittest.TestCase): @@ -395,24 +382,25 @@ class TestFileTypeBox(unittest.TestCase): def tearDown(self): pass + @unittest.skipIf(WARNING_INFRASTRUCTURE_ISSUE, WARNING_INFRASTRUCTURE_MSG) def test_brand_unknown(self): """A ftyp box brand must be 'jp2 ' or 'jpx '.""" - with warnings.catch_warnings(): - warnings.simplefilter("ignore") + with self.assertWarns(UserWarning): ftyp = glymur.jp2box.FileTypeBox(brand='jp3') with self.assertRaises(IOError): with tempfile.TemporaryFile() as tfile: - ftyp.write(tfile) + ftyp.write(tfile) + @unittest.skipIf(WARNING_INFRASTRUCTURE_ISSUE, WARNING_INFRASTRUCTURE_MSG) def test_cl_entry_unknown(self): """A ftyp box cl list can only contain 'jp2 ', 'jpx ', or 'jpxb'.""" - with warnings.catch_warnings(): + with self.assertWarns(UserWarning): # Bad compatibility list item. - warnings.simplefilter("ignore") ftyp = glymur.jp2box.FileTypeBox(compatibility_list=['jp3']) with self.assertRaises(IOError): with tempfile.TemporaryFile() as tfile: - ftyp.write(tfile) + ftyp.write(tfile) + class TestColourSpecificationBox(unittest.TestCase): """Test suite for colr box instantiation.""" @@ -436,8 +424,7 @@ class TestColourSpecificationBox(unittest.TestCase): def tearDown(self): pass - @unittest.skipIf(os.name == "nt", - "Problems using NamedTemporaryFile on windows.") + @unittest.skipIf(os.name == "nt", WINDOWS_TMP_FILE_MSG) def test_colr_with_out_enum_cspace(self): """must supply an enumerated colorspace when writing""" j2k = Jp2k(self.j2kfile) @@ -448,7 +435,7 @@ class TestColourSpecificationBox(unittest.TestCase): with self.assertRaises(IOError): j2k.wrap(tfile.name, boxes=boxes) - @unittest.skipIf(os.name == "nt", "Temporary file issue on window.") + @unittest.skipIf(os.name == "nt", WINDOWS_TMP_FILE_MSG) def test_missing_colr_box(self): """jp2h must have a colr box""" j2k = Jp2k(self.j2kfile) @@ -458,7 +445,7 @@ class TestColourSpecificationBox(unittest.TestCase): with self.assertRaises(IOError): j2k.wrap(tfile.name, boxes=boxes) - @unittest.skipIf(os.name == "nt", "Temporary file issue on window.") + @unittest.skipIf(os.name == "nt", WINDOWS_TMP_FILE_MSG) def test_bad_approx_jp2_field(self): """JP2 has requirements for approx field""" j2k = Jp2k(self.j2kfile) @@ -479,41 +466,34 @@ class TestColourSpecificationBox(unittest.TestCase): self.assertEqual(colr.colorspace, glymur.core.SRGB) self.assertIsNone(colr.icc_profile) + @unittest.skipIf(WARNING_INFRASTRUCTURE_ISSUE, WARNING_INFRASTRUCTURE_MSG) def test_colr_with_cspace_and_icc(self): """Colour specification boxes can't have both.""" - with warnings.catch_warnings(record=True) as w: - warnings.simplefilter('always') + regex = 'Colorspace and icc_profile cannot both be set' + with self.assertWarnsRegex(UserWarning, regex): colorspace = glymur.core.SRGB rawb = b'\x01\x02\x03\x04' glymur.jp2box.ColourSpecificationBox(colorspace=colorspace, icc_profile=rawb) - self.assertTrue(issubclass(w[0].category,UserWarning)) - msg = 'Colorspace and icc_profile cannot both be set' - self.assertTrue(msg in str(w[0].message)) + @unittest.skipIf(WARNING_INFRASTRUCTURE_ISSUE, WARNING_INFRASTRUCTURE_MSG) def test_colr_with_bad_method(self): """colr must have a valid method field""" colorspace = glymur.core.SRGB method = -1 - with warnings.catch_warnings(record=True) as w: - warnings.simplefilter('always') + regex = 'Invalid method' + with self.assertWarnsRegex(UserWarning, regex): glymur.jp2box.ColourSpecificationBox(colorspace=colorspace, method=method) - self.assertTrue(issubclass(w[0].category,UserWarning)) - msg = 'Invalid method' - self.assertTrue(msg in str(w[0].message)) + @unittest.skipIf(WARNING_INFRASTRUCTURE_ISSUE, WARNING_INFRASTRUCTURE_MSG) def test_colr_with_bad_approx(self): """colr should have a valid approximation field""" colorspace = glymur.core.SRGB approx = -1 - with warnings.catch_warnings(record=True) as w: - warnings.simplefilter('always') + with self.assertWarnsRegex(UserWarning, 'Invalid approximation'): glymur.jp2box.ColourSpecificationBox(colorspace=colorspace, approximation=approx) - self.assertTrue(issubclass(w[0].category,UserWarning)) - msg = 'Invalid approximation' - self.assertTrue(msg in str(w[0].message)) def test_colr_with_bad_color(self): """colr must have a valid color, strange as though that may sound.""" @@ -526,8 +506,7 @@ class TestColourSpecificationBox(unittest.TestCase): colr.write(tfile) -@unittest.skipIf(os.name == "nt", - "Problems using NamedTemporaryFile on windows.") +@unittest.skipIf(os.name == "nt", WINDOWS_TMP_FILE_MSG) class TestPaletteBox(unittest.TestCase): """Test suite for pclr box instantiation.""" @@ -537,29 +516,25 @@ class TestPaletteBox(unittest.TestCase): def tearDown(self): pass + @unittest.skipIf(WARNING_INFRASTRUCTURE_ISSUE, WARNING_INFRASTRUCTURE_MSG) def test_mismatched_bitdepth_signed(self): """bitdepth and signed arguments must have equal length""" palette = np.array([[255, 0, 255], [0, 255, 0]], dtype=np.uint8) bps = (8, 8, 8) signed = (False, False) - with warnings.catch_warnings(record=True) as w: - warnings.simplefilter('always') - pclr = glymur.jp2box.PaletteBox(palette, bits_per_component=bps, - signed=signed) - self.assertEqual(len(w), 1) - self.assertTrue(issubclass(w[0].category, UserWarning)) + with self.assertWarns(UserWarning): + glymur.jp2box.PaletteBox(palette, bits_per_component=bps, + signed=signed) + @unittest.skipIf(WARNING_INFRASTRUCTURE_ISSUE, WARNING_INFRASTRUCTURE_MSG) def test_mismatched_signed_palette(self): """bitdepth and signed arguments must have equal length""" palette = np.array([[255, 0, 255], [0, 255, 0]], dtype=np.uint8) bps = (8, 8, 8, 8) signed = (False, False, False, False) - with warnings.catch_warnings(record=True) as w: - warnings.simplefilter('always') - pclr = glymur.jp2box.PaletteBox(palette, bits_per_component=bps, - signed=signed) - self.assertEqual(len(w), 1) - self.assertTrue(issubclass(w[0].category, UserWarning)) + with self.assertWarns(UserWarning): + glymur.jp2box.PaletteBox(palette, bits_per_component=bps, + signed=signed) def test_writing_with_different_bitdepths(self): """Bitdepths must be the same when writing.""" @@ -573,7 +548,7 @@ class TestPaletteBox(unittest.TestCase): pclr.write(tfile) -@unittest.skipIf(os.name == "nt", "Temporary file issue on window.") +@unittest.skipIf(os.name == "nt", WINDOWS_TMP_FILE_MSG) class TestAppend(unittest.TestCase): """Tests for append method.""" @@ -659,14 +634,14 @@ class TestAppend(unittest.TestCase): jp2 = Jp2k(tfile.name) # Make a UUID box. Only XMP UUID boxes can currently be appended. - uuid_instance = uuid.UUID('00000000-0000-0000-0000-000000000000') + uuid_instance = UUID('00000000-0000-0000-0000-000000000000') data = b'0123456789' uuidbox = glymur.jp2box.UUIDBox(uuid_instance, data) with self.assertRaises(IOError): jp2.append(uuidbox) -@unittest.skipIf(os.name == "nt", "Temporary file issue on window.") +@unittest.skipIf(os.name == "nt", WINDOWS_TMP_FILE_MSG) class TestWrap(unittest.TestCase): """Tests for wrap method.""" @@ -815,7 +790,7 @@ class TestWrap(unittest.TestCase): # list to trigger the error. boxes[2].box = [] with self.assertRaises(IOError): - jp22 = jp2.wrap(tfile.name, boxes=boxes) + jp2.wrap(tfile.name, boxes=boxes) def test_default_layout_with_boxes(self): """basic test for rewrapping a jp2 file, boxes specified""" @@ -880,8 +855,8 @@ class TestWrap(unittest.TestCase): """A palette box must reside in a JP2 header box.""" palette = np.array([[255, 0, 255], [0, 255, 0]], dtype=np.int32) bps = (8, 8, 8) - signed = (True, False, True) - pclr = glymur.jp2box.PaletteBox(palette=palette, bits_per_component=bps, + pclr = glymur.jp2box.PaletteBox(palette=palette, + bits_per_component=bps, signed=(True, False, True)) j2k = Jp2k(self.j2kfile) @@ -993,7 +968,8 @@ class TestWrap(unittest.TestCase): """Rewrap a jpx file.""" with tempfile.NamedTemporaryFile(suffix='.jp2') as tfile1: jpx = Jp2k(self.jpxfile) - idx = list(range(5)) + list(range(9, 12)) + list(range(6, 9)) + [12] + idx = (list(range(5)) + + list(range(9, 12)) + list(range(6, 9))) + [12] boxes = [jpx.box[j] for j in idx] jpx2 = jpx.wrap(tfile1.name, boxes=boxes) exp_ids = [box.box_id for box in boxes] @@ -1045,16 +1021,16 @@ class TestJp2Boxes(unittest.TestCase): """Raw instantiation should not produce a main_header.""" box = ContiguousCodestreamBox() self.assertEqual(box.box_id, 'jp2c') - self.assertIsNone(box.main_header) + self.assertIsNone(box.codestream) def test_codestream_main_header_offset(self): """main_header_offset is an attribute of the CCS box""" - j = Jp2k(self.jpxfile); + j = Jp2k(self.jpxfile) self.assertEqual(j.box[5].main_header_offset, j.box[5].offset + 8) -class TestRepr(unittest.TestCase): +class TestRepr(MetadataBase): """Tests for __repr__ methods.""" def test_default_jp2k(self): """Should be able to eval a JPEG2000SignatureBox""" @@ -1124,10 +1100,7 @@ class TestRepr(unittest.TestCase): # Test the representation instantiation. newbox = eval(repr(ftyp)) - self.assertTrue(isinstance(newbox, glymur.jp2box.FileTypeBox)) - self.assertEqual(newbox.brand, 'jp2 ') - self.assertEqual(newbox.minor_version, 0) - self.assertEqual(newbox.compatibility_list, ['jp2 ']) + self.verify_filetype_box(newbox, FileTypeBox()) def test_colourspecification_box(self): """Verify __repr__ method on colr box.""" @@ -1253,8 +1226,8 @@ class TestRepr(unittest.TestCase): def test_uuidlist_box(self): """Verify __repr__ method on ulst box.""" - uuid1 = uuid.UUID('00000000-0000-0000-0000-000000000001') - uuid2 = uuid.UUID('00000000-0000-0000-0000-000000000002') + uuid1 = UUID('00000000-0000-0000-0000-000000000001') + uuid2 = UUID('00000000-0000-0000-0000-000000000002') uuids = [uuid1, uuid2] ulst = glymur.jp2box.UUIDListBox(ulst=uuids) newbox = eval(repr(ulst)) @@ -1262,21 +1235,10 @@ class TestRepr(unittest.TestCase): self.assertEqual(newbox.ulst[0], uuid1) self.assertEqual(newbox.ulst[1], uuid2) - def test_jp2k_box(self): - """Verify Superclass repr.""" - box = glymur.jp2box.Jp2kBox(box_id='one', offset=2, length=3, - longname='four') - newbox = eval(repr(box)) - self.assertEqual(newbox.box_id, 'one') - self.assertEqual(newbox.offset, 2) - self.assertEqual(newbox.length, 3) - self.assertEqual(newbox.longname, 'four') - def test_palette_box(self): """Verify Palette box repr.""" palette = np.array([[255, 0, 1000], [0, 255, 0]], dtype=np.int32) bps = (8, 8, 16) - signed = (True, False, True) box = glymur.jp2box.PaletteBox(palette=palette, bits_per_component=bps, signed=(True, False, True)) @@ -1319,14 +1281,15 @@ class TestRepr(unittest.TestCase): def test_uuid_box_generic(self): """Verify uuid repr method.""" - uuid_instance = uuid.UUID('00000000-0000-0000-0000-000000000000') + uuid_instance = UUID('00000000-0000-0000-0000-000000000000') data = b'0123456789' box = glymur.jp2box.UUIDBox(the_uuid=uuid_instance, raw_data=data) # Since the raw_data parameter is a sequence of bytes which could be # quite long, don't bother trying to make it conform to eval(repr()). regexp = r"""glymur.jp2box.UUIDBox\(""" - regexp += """the_uuid=UUID\('00000000-0000-0000-0000-000000000000'\),\s""" + regexp += """the_uuid=""" + regexp += """UUID\('00000000-0000-0000-0000-000000000000'\),\s""" regexp += """raw_data=\)""" if sys.hexversion < 0x03000000: @@ -1343,7 +1306,8 @@ class TestRepr(unittest.TestCase): # Since the raw_data parameter is a sequence of bytes which could be # quite long, don't bother trying to make it conform to eval(repr()). regexp = r"""glymur.jp2box.UUIDBox\(""" - regexp += """the_uuid=UUID\('be7acfcb-97a9-42e8-9c71-999491e3afac'\),\s""" + regexp += """the_uuid=""" + regexp += """UUID\('be7acfcb-97a9-42e8-9c71-999491e3afac'\),\s""" regexp += """raw_data=\)""" if sys.hexversion < 0x03000000: @@ -1359,49 +1323,10 @@ class TestRepr(unittest.TestCase): # Difficult to eval(repr()) this, so just match the general pattern. regexp = "glymur.jp2box.ContiguousCodeStreamBox" - regexp += "[(]main_header=> 16, - standard_masks[j] & 0x0000ffff>> 8, + standard_masks[j] & 0x0000ffff >> 8, standard_masks[j] & 0x000000ff) struct.pack_into('>HBBB', rreq_buffer, 17 + j * 5, standard_flags[j], *mask) @@ -602,7 +599,6 @@ class TestJPX(unittest.TestCase): self.assertEqual(jpx.box[2].standard_flag, (5, 42, 45, 2, 18, 19, 1, 8, 12, 31, 20)) - def test_nlst(self): """Verify that we can handle a number list box.""" j = Jp2k(self.jpxfile) diff --git a/glymur/test/test_jp2box_uuid.py b/glymur/test/test_jp2box_uuid.py index 44808bb..6886c30 100644 --- a/glymur/test/test_jp2box_uuid.py +++ b/glymur/test/test_jp2box_uuid.py @@ -1,53 +1,32 @@ # -*- coding: utf-8 -*- """Test suite for printing. """ -# C0302: don't care too much about having too many lines in a test module -# pylint: disable=C0302 - -# E061: unittest.mock introduced in 3.3 (python-2.7/pylint issue) -# pylint: disable=E0611,F0401 - -# R0904: Not too many methods in unittest. -# pylint: disable=R0904 - import os -import re import shutil import struct import sys import tempfile import uuid -import warnings if sys.hexversion < 0x02070000: import unittest2 as unittest else: import unittest -if sys.hexversion < 0x03000000: - from StringIO import StringIO -else: - from io import StringIO - -if sys.hexversion <= 0x03030000: - from mock import patch -else: - from unittest.mock import patch - import lxml.etree -from .fixtures import HAS_PYTHON_XMP_TOOLKIT, OPJ_DATA_ROOT -if HAS_PYTHON_XMP_TOOLKIT: - from libxmp import XMPMeta +from .fixtures import (WARNING_INFRASTRUCTURE_ISSUE, + WARNING_INFRASTRUCTURE_MSG, + WINDOWS_TMP_FILE_MSG) import glymur from glymur import Jp2k -from .fixtures import OPJ_DATA_ROOT, opj_data_file, SimpleRDF +from .fixtures import SimpleRDF -@unittest.skipIf(os.name == "nt", "Unexplained failure on windows") -class TestUUIDXMP(unittest.TestCase): - """Tests for UUIDs of XMP type.""" +@unittest.skipIf(os.name == "nt", WINDOWS_TMP_FILE_MSG) +class TestSuite(unittest.TestCase): + """Tests for XMP, Exif UUIDs.""" def setUp(self): self.jp2file = glymur.data.nemo() @@ -55,7 +34,7 @@ class TestUUIDXMP(unittest.TestCase): def tearDown(self): pass - def test_append(self): + def test_append_xmp_uuid(self): """Should be able to append an XMP UUID box.""" the_uuid = uuid.UUID('be7acfcb-97a9-42e8-9c71-999491e3afac') raw_data = SimpleRDF.encode('utf-8') @@ -75,9 +54,36 @@ class TestUUIDXMP(unittest.TestCase): self.assertTrue(isinstance(jp2.box[-1].data, lxml.etree._ElementTree)) -@unittest.skipIf(os.name == "nt", "Unexplained failure on windows") -class TestUUIDExif(unittest.TestCase): - """Tests for UUIDs of Exif type.""" + def test_big_endian_exif(self): + """Verify read of Exif big-endian IFD.""" + with tempfile.NamedTemporaryFile(suffix='.jp2', mode='wb') as tfile: + + with open(self.jp2file, 'rb') as ifptr: + tfile.write(ifptr.read()) + + # Write L, T, UUID identifier. + tfile.write(struct.pack('>I4s', 52, b'uuid')) + tfile.write(b'JpgTiffExif->JP2') + + tfile.write(b'Exif\x00\x00') + xbuffer = struct.pack('>BBHI', 77, 77, 42, 8) + tfile.write(xbuffer) + + # We will write just a single tag. + tfile.write(struct.pack('>H', 1)) + + # The "Make" tag is tag no. 271. + tfile.write(struct.pack('>HHI4s', 271, 2, 3, b'HTC\x00')) + tfile.flush() + + jp2 = glymur.Jp2k(tfile.name) + self.assertEqual(jp2.box[-1].data['Make'], "HTC") + + +@unittest.skipIf(WARNING_INFRASTRUCTURE_ISSUE, WARNING_INFRASTRUCTURE_MSG) +@unittest.skipIf(os.name == "nt", WINDOWS_TMP_FILE_MSG) +class TestSuiteWarns(unittest.TestCase): + """Tests for XMP, Exif UUIDs, issues warnings.""" def setUp(self): self.jp2file = glymur.data.nemo() @@ -107,12 +113,8 @@ class TestUUIDExif(unittest.TestCase): tfile.write(struct.pack('I4s', 52, b'uuid')) - tfile.write(b'JpgTiffExif->JP2') - - tfile.write(b'Exif\x00\x00') - xbuffer = struct.pack('>BBHI', 77, 77, 42, 8) - tfile.write(xbuffer) - - # We will write just a single tag. - tfile.write(struct.pack('>H', 1)) - - # The "Make" tag is tag no. 271. - tfile.write(struct.pack('>HHI4s', 271, 2, 3, b'HTC\x00')) - tfile.flush() - - jp2 = glymur.Jp2k(tfile.name) - self.assertEqual(jp2.box[-1].data['Make'], "HTC") - -if __name__ == "__main__": - unittest.main() + self.assertEqual(jp2.box[-1].box_id, 'uuid') diff --git a/glymur/test/test_jp2box_xml.py b/glymur/test/test_jp2box_xml.py index 91de04a..87bdd38 100644 --- a/glymur/test/test_jp2box_xml.py +++ b/glymur/test/test_jp2box_xml.py @@ -2,34 +2,11 @@ """ Test suite specifically targeting JP2 box layout. """ -# E1103: return value from read may be list or np array -# pylint: disable=E1103 - -# R0902: More than 7 instance attributes are just fine for testing. -# pylint: disable=R0902 - -# R0904: Seems like pylint is fooled in this situation -# pylint: disable=R0904 - -# W0613: load_tests doesn't need to use ignore or loader arguments. -# pylint: disable=W0613 - import os +import re import struct -import sys import tempfile import unittest -import warnings - -if sys.hexversion < 0x03000000: - from StringIO import StringIO -else: - from io import StringIO - -if sys.hexversion <= 0x03030000: - from mock import patch -else: - from unittest.mock import patch import lxml.etree as ET @@ -40,8 +17,11 @@ from glymur.jp2box import FileTypeBox, ImageHeaderBox, JP2HeaderBox from glymur.jp2box import JPEG2000SignatureBox from .fixtures import OPJ_DATA_ROOT, opj_data_file +from .fixtures import WARNING_INFRASTRUCTURE_ISSUE, WARNING_INFRASTRUCTURE_MSG +from . import fixtures -@unittest.skipIf(os.name == "nt", "Temporary file issue on window.") + +@unittest.skipIf(os.name == "nt", fixtures.WINDOWS_TMP_FILE_MSG) class TestXML(unittest.TestCase): """Test suite for XML boxes.""" @@ -165,8 +145,6 @@ class TestXML(unittest.TestCase): u'Россия') - -@unittest.skipIf(os.name == "nt", "NamedTemporaryFile issue on windows") class TestJp2kBadXmlFile(unittest.TestCase): """Test suite for bad XML box situations""" @@ -207,14 +185,11 @@ class TestJp2kBadXmlFile(unittest.TestCase): def tearDown(self): pass + @unittest.skipIf(WARNING_INFRASTRUCTURE_ISSUE, WARNING_INFRASTRUCTURE_MSG) def test_invalid_xml_box(self): """Should be able to recover info from xml box with bad xml.""" - with warnings.catch_warnings(record=True) as w: - warnings.simplefilter("always") + with self.assertWarns(UserWarning): jp2k = Jp2k(self._bad_xml_file) - self.assertTrue(issubclass(w[0].category, UserWarning)) - msg = 'No XML was retrieved' - self.assertTrue(msg in str(w[0].message)) self.assertEqual(jp2k.box[3].box_id, 'xml ') self.assertEqual(jp2k.box[3].offset, 77) @@ -222,7 +197,7 @@ class TestJp2kBadXmlFile(unittest.TestCase): self.assertIsNone(jp2k.box[3].xml) -@unittest.skipIf(os.name == "nt", "NamedTemporaryFile issue on windows") +@unittest.skipIf(os.name == "nt", fixtures.WINDOWS_TMP_FILE_MSG) class TestBadButRecoverableXmlFile(unittest.TestCase): """Test suite for XML box that is bad, but we can still recover the XML.""" @@ -263,19 +238,17 @@ class TestBadButRecoverableXmlFile(unittest.TestCase): def tearDownClass(cls): os.unlink(cls._bad_xml_file) + @unittest.skipIf(WARNING_INFRASTRUCTURE_ISSUE, WARNING_INFRASTRUCTURE_MSG) def test_bad_xml_box_warning(self): """Should warn in case of bad XML""" - with warnings.catch_warnings(record=True) as w: - warnings.simplefilter('always') + regex = 'A UnicodeDecodeError was encountered parsing an XML box' + with self.assertWarnsRegex(UserWarning, regex): Jp2k(self._bad_xml_file) - self.assertTrue(issubclass(w[0].category, UserWarning)) - msg = 'A UnicodeDecodeError was encountered parsing an XML box' - self.assertTrue(msg in str(w[0].message)) + @unittest.skipIf(WARNING_INFRASTRUCTURE_ISSUE, WARNING_INFRASTRUCTURE_MSG) def test_recover_from_bad_xml(self): """Should be able to recover info from xml box with bad xml.""" - with warnings.catch_warnings(): - warnings.simplefilter("ignore") + with self.assertWarns(UserWarning): jp2 = Jp2k(self._bad_xml_file) self.assertEqual(jp2.box[3].box_id, 'xml ') @@ -285,38 +258,31 @@ class TestBadButRecoverableXmlFile(unittest.TestCase): b'this is a test') +@unittest.skipIf(WARNING_INFRASTRUCTURE_ISSUE, WARNING_INFRASTRUCTURE_MSG) @unittest.skipIf(OPJ_DATA_ROOT is None, "OPJ_DATA_ROOT environment variable not set") class TestXML_OpjDataRoot(unittest.TestCase): """Test suite for XML boxes, requires OPJ_DATA_ROOT.""" - @unittest.skipIf(sys.platform.startswith('linux'), 'Failing on linux') def test_bom(self): """Byte order markers are illegal in UTF-8. Issue 185""" filename = opj_data_file(os.path.join('input', 'nonregression', 'issue171.jp2')) - with warnings.catch_warnings(record=True) as w: - warnings.simplefilter("always") + msg = 'An illegal BOM \(byte order marker\) was detected and removed ' + msg += 'from the XML contents in the box starting at byte offset \d+' + with self.assertWarnsRegex(UserWarning, re.compile(msg)): jp2 = Jp2k(filename) - self.assertTrue(issubclass(w[0].category, UserWarning)) - msg = 'An illegal BOM (byte order marker) was detected and removed' - self.assertTrue(msg in str(w[0].message)) self.assertIsNotNone(jp2.box[3].xml) - def test_invalid_utf8(self): """Bad byte sequence that cannot be parsed.""" + relname = '26ccf3651020967f7778238ef5af08af.SIGFPE.d25.527.jp2' filename = opj_data_file(os.path.join('input', 'nonregression', - '26ccf3651020967f7778238ef5af08af.SIGFPE.d25.527.jp2')) - with warnings.catch_warnings(record=True) as w: - warnings.simplefilter("always") + relname)) + with self.assertWarns((UserWarning, UserWarning)): jp2 = Jp2k(filename) - self.assertTrue(issubclass(w[0].category, UserWarning)) self.assertIsNone(jp2.box[3].box[1].box[1].xml) - - - diff --git a/glymur/test/test_jp2k.py b/glymur/test/test_jp2k.py index 63492a5..52945f9 100644 --- a/glymur/test/test_jp2k.py +++ b/glymur/test/test_jp2k.py @@ -1,35 +1,33 @@ """ Tests for general glymur functionality. """ -# E1101: assertWarns introduced in python 3.2 -# pylint: disable=E1101 - -# R0904: Not too many methods in unittest. -# pylint: disable=R0904 - -# E0611: unittest.mock is unknown to python2.7/pylint -# pylint: disable=E0611,F0401 - import doctest import os import re -import shutil import struct import sys import tempfile import unittest import uuid +import warnings from xml.etree import cElementTree as ET -import warnings +if sys.hexversion <= 0x03030000: + from mock import patch +else: + from unittest.mock import patch import numpy as np import pkg_resources import glymur from glymur import Jp2k +from glymur.version import openjpeg_version from .fixtures import HAS_PYTHON_XMP_TOOLKIT +from .fixtures import WARNING_INFRASTRUCTURE_ISSUE, WARNING_INFRASTRUCTURE_MSG +from .fixtures import OPENJPEG_NOT_AVAILABLE, OPENJPEG_NOT_AVAILABLE_MSG + if HAS_PYTHON_XMP_TOOLKIT: import libxmp from libxmp import XMPMeta @@ -37,21 +35,203 @@ if HAS_PYTHON_XMP_TOOLKIT: from .fixtures import OPJ_DATA_ROOT, opj_data_file from . import fixtures + +def docTearDown(doctest_obj): + glymur.set_parseoptions(full_codestream=False) + + # Doc tests should be run as well. def load_tests(loader, tests, ignore): - # W0613: "loader" and "ignore" are necessary for the protocol - # They are unused here, however. - # pylint: disable=W0613 - """Should run doc tests as well""" if os.name == "nt": # Can't do it on windows, temporary file issue. return tests if glymur.lib.openjp2.OPENJP2 is not None: - tests.addTests(doctest.DocTestSuite('glymur.jp2k')) + tests.addTests(doctest.DocTestSuite('glymur.jp2k', + tearDown=docTearDown)) return tests +class SliceProtocolBase(unittest.TestCase): + """ + Test slice protocol, i.e. when using [ ] to read image data. + """ + @classmethod + def setUpClass(self): + + self.jp2 = Jp2k(glymur.data.nemo()) + self.jp2_data = self.jp2[:] + self.jp2_data_r1 = self.jp2[::2, ::2] + + self.j2k = Jp2k(glymur.data.goodstuff()) + self.j2k_data = self.j2k[:] + + self.j2k_data_r1 = self.j2k[::2, ::2] + self.j2k_data_r5 = self.j2k[::32, ::32] + + +@unittest.skipIf(OPENJPEG_NOT_AVAILABLE, OPENJPEG_NOT_AVAILABLE_MSG) +@unittest.skipIf(re.match("1.5|2", glymur.version.openjpeg_version) is None, + "Must have openjpeg 1.5 or higher to run") +@unittest.skipIf(os.name == "nt", fixtures.WINDOWS_TMP_FILE_MSG) +class TestSliceProtocolBaseWrite(SliceProtocolBase): + + def test_write_ellipsis(self): + expected = self.j2k_data + + with tempfile.NamedTemporaryFile(suffix='.j2k') as tfile: + j = Jp2k(tfile.name, shape=expected.shape) + j[...] = expected + actual = j[:] + + np.testing.assert_array_equal(actual, expected) + + def test_basic_write(self): + expected = self.j2k_data + + with tempfile.NamedTemporaryFile(suffix='.j2k') as tfile: + j = Jp2k(tfile.name, data=self.j2k_data) + actual = j[:] + + np.testing.assert_array_equal(actual, expected) + + def test_cannot_write_with_non_default_single_slice(self): + with tempfile.NamedTemporaryFile(suffix='.j2k') as tfile: + j = Jp2k(tfile.name, shape=self.j2k_data.shape) + with self.assertRaises(TypeError): + j[slice(None, 0)] = self.j2k_data + with self.assertRaises(TypeError): + j[slice(0, None)] = self.j2k_data + with self.assertRaises(TypeError): + j[slice(0, 0, None)] = self.j2k_data + with self.assertRaises(TypeError): + j[slice(0, 640)] = self.j2k_data + + def test_cannot_write_a_row(self): + with tempfile.NamedTemporaryFile(suffix='.j2k') as tfile: + j = Jp2k(tfile.name, shape=self.j2k_data.shape) + with self.assertRaises(TypeError): + j[5] = self.j2k_data + + def test_cannot_write_a_pixel(self): + with tempfile.NamedTemporaryFile(suffix='.j2k') as tfile: + j = Jp2k(tfile.name, shape=self.j2k_data.shape) + with self.assertRaises(TypeError): + j[25, 35] = self.j2k_data[25, 35] + + def test_cannot_write_a_column(self): + with tempfile.NamedTemporaryFile(suffix='.j2k') as tfile: + j = Jp2k(tfile.name, shape=self.j2k_data.shape) + with self.assertRaises(TypeError): + j[:, 25, :] = self.j2k_data[:, :25, :] + + def test_cannot_write_a_band(self): + with tempfile.NamedTemporaryFile(suffix='.j2k') as tfile: + j = Jp2k(tfile.name, shape=self.j2k_data.shape) + with self.assertRaises(TypeError): + j[:, :, 0] = self.j2k_data[:, :, 0] + + def test_cannot_write_a_subarray(self): + with tempfile.NamedTemporaryFile(suffix='.j2k') as tfile: + j = Jp2k(tfile.name, shape=self.j2k_data.shape) + with self.assertRaises(TypeError): + j[:25, :45, :] = self.j2k_data[:25, :25, :] + + +@unittest.skipIf(OPENJPEG_NOT_AVAILABLE, OPENJPEG_NOT_AVAILABLE_MSG) +class TestSliceProtocolRead(SliceProtocolBase): + + def test_resolution_strides_cannot_differ(self): + with self.assertRaises(IndexError): + # Strides in x/y directions cannot differ. + self.j2k[::2, ::3] + + def test_resolution_strides_must_be_powers_of_two(self): + with self.assertRaises(IndexError): + self.j2k[::3, ::3] + + def test_integer_index_in_3d(self): + + for j in [0, 1, 2]: + band = self.j2k[:, :, j] + np.testing.assert_array_equal(self.j2k_data[:, :, j], band) + + def test_slice_in_third_dimension(self): + actual = self.j2k[:, :, 1:3] + expected = self.j2k_data[:, :, 1:3] + np.testing.assert_array_equal(actual, expected) + + def test_reduce_resolution_and_slice_in_third_dimension(self): + actual = self.j2k[::2, ::2, 1:3] + expected = self.j2k_data_r1[:, :, 1:3] + np.testing.assert_array_equal(actual, expected) + + def test_retrieve_single_row(self): + actual = self.jp2[0] + expected = self.jp2_data[0] + np.testing.assert_array_equal(actual, expected) + + def test_retrieve_single_pixel(self): + actual = self.jp2[0, 0] + expected = self.jp2_data[0, 0] + np.testing.assert_array_equal(actual, expected) + + def test_retrieve_single_component(self): + actual = self.jp2[20, 20, 2] + expected = self.jp2_data[20, 20, 2] + np.testing.assert_array_equal(actual, expected) + + def test_ellipsis_full_read(self): + actual = self.j2k[...] + expected = self.j2k_data + np.testing.assert_array_equal(actual, expected) + + def test_ellipsis_band_select(self): + actual = self.j2k[..., 0] + expected = self.j2k_data[..., 0] + np.testing.assert_array_equal(actual, expected) + + def test_ellipsis_row_select(self): + actual = self.j2k[0, ...] + expected = self.j2k_data[0, ...] + np.testing.assert_array_equal(actual, expected) + + def test_two_ellipsis_band_select(self): + actual = self.j2k[..., ..., 1] + expected = self.j2k_data[:, :, 1] + np.testing.assert_array_equal(actual, expected) + + def test_two_ellipsis_row_select(self): + actual = self.j2k[1, ..., ...] + expected = self.j2k_data[1, :, :] + np.testing.assert_array_equal(actual, expected) + + def test_two_ellipsis_and_full_slice(self): + actual = self.j2k[..., ..., :] + expected = self.j2k_data[:] + np.testing.assert_array_equal(actual, expected) + + def test_single_slice(self): + rows = slice(3, 8) + actual = self.j2k[rows] + expected = self.j2k_data[3:8, :, :] + np.testing.assert_array_equal(actual, expected) + + @unittest.skipIf(re.match("0|1", glymur.version.openjpeg_version), + "Must have openjpeg 2 or higher to run") + def test_region_rlevel5(self): + """ + maximim rlevel + + There seems to be a difference between version of openjpeg, as + openjp2 produces an image of size (16, 13, 3) and openjpeg produced + (17, 12, 3). + """ + actual = self.j2k[5:533:32, 27:423:32] + expected = self.j2k_data_r5[1:17, 1:14] + np.testing.assert_array_equal(actual, expected) + + class TestJp2k(unittest.TestCase): """These tests should be run by just about all configuration.""" @@ -63,30 +243,80 @@ class TestJp2k(unittest.TestCase): def tearDown(self): pass + @unittest.skipIf(OPENJPEG_NOT_AVAILABLE, OPENJPEG_NOT_AVAILABLE_MSG) + @unittest.skipIf(WARNING_INFRASTRUCTURE_ISSUE, WARNING_INFRASTRUCTURE_MSG) + def test_warn_if_using_read_method(self): + """Should warn if deprecated read method is called""" + with self.assertWarns(DeprecationWarning): + Jp2k(self.jp2file).read() + + def test_shape_jp2(self): + """verify shape attribute for JP2 file + """ + jp2 = Jp2k(self.jp2file) + self.assertEqual(jp2.shape, (1456, 2592, 3)) + + @unittest.skipIf(OPJ_DATA_ROOT is None, + "OPJ_DATA_ROOT environment variable not set") + def test_shape_greyscale_jp2(self): + """verify shape attribute for greyscale JP2 file + """ + with warnings.catch_warnings(): + # Suppress a warning due to bad compatibility list entry. + warnings.simplefilter("ignore") + jfile = opj_data_file('input/conformance/file4.jp2') + jp2 = Jp2k(jfile) + self.assertEqual(jp2.shape, (512, 768)) + + @unittest.skipIf(OPJ_DATA_ROOT is None, + "OPJ_DATA_ROOT environment variable not set") + def test_shape_single_channel_j2k(self): + """verify shape attribute for single channel J2K file + """ + jfile = opj_data_file('input/conformance/p0_01.j2k') + jp2 = Jp2k(jfile) + self.assertEqual(jp2.shape, (128, 128)) + + def test_shape_j2k(self): + """verify shape attribute for J2K file + """ + j2k = Jp2k(self.j2kfile) + self.assertEqual(j2k.shape, (800, 480, 3)) + + def test_shape_jpx_jp2(self): + """verify shape attribute for JPX file with JP2 compatibility + """ + jpx = Jp2k(self.jpxfile) + self.assertEqual(jpx.shape, (1024, 1024, 3)) + + @unittest.skipIf(re.match("0|1.[0-4]", glymur.version.openjpeg_version), + "Must have openjpeg 1.5 or higher to run") @unittest.skipIf(os.name == "nt", "Unexplained failure on windows") def test_irreversible(self): """Irreversible""" j = Jp2k(self.jp2file) - expdata = j.read() + expdata = j[:] with tempfile.NamedTemporaryFile(suffix='.j2k') as tfile: - j2 = Jp2k(tfile.name, 'wb') - j2.write(expdata, irreversible=True) + j2 = Jp2k(tfile.name, data=expdata, irreversible=True) codestream = j2.get_codestream() self.assertEqual(codestream.segment[2].spcod[8], glymur.core.WAVELET_XFORM_9X7_IRREVERSIBLE) - actdata = j2.read() + actdata = j2[:] self.assertTrue(fixtures.mse(actdata[0], expdata[0]) < 0.38) - @unittest.skipIf(re.match('1.5.(1|2)', - glymur.version.openjpeg_version) is not None, + @unittest.skipIf(OPENJPEG_NOT_AVAILABLE, OPENJPEG_NOT_AVAILABLE_MSG) + @unittest.skipIf(re.match('1.[0-4]', openjpeg_version) is not None, + "Not supported on OpenJPEG {0}".format(openjpeg_version)) + @unittest.skipIf(re.match('1.5.(1|2)', openjpeg_version) is not None, "Mysteriously fails in 1.5.1 and 1.5.2") def test_no_cxform_pclr_jpx(self): """Indices for pclr jpxfile if no color transform""" j = Jp2k(self.jpxfile) - rgb = j.read() - idx = j.read(ignore_pclr_cmap_cdef=True) + rgb = j[:] + j.ignore_pclr_cmap_cdef = True + idx = j[:] nr, nc = 1024, 1024 self.assertEqual(rgb.shape, (nr, nc, 3)) self.assertEqual(idx.shape, (nr, nc)) @@ -107,22 +337,37 @@ class TestJp2k(unittest.TestCase): newjp2 = eval(repr(j)) self.assertEqual(newjp2.filename, self.j2kfile) - self.assertEqual(newjp2.mode, 'rb') self.assertEqual(len(newjp2.box), 0) - def test_rlevel_max(self): - """Verify that rlevel=-1 gets us the lowest resolution image""" + @unittest.skipIf(OPENJPEG_NOT_AVAILABLE, OPENJPEG_NOT_AVAILABLE_MSG) + @unittest.skipIf(WARNING_INFRASTRUCTURE_ISSUE, WARNING_INFRASTRUCTURE_MSG) + def test_rlevel_max_backwards_compatibility(self): + """ + Verify that rlevel=-1 gets us the lowest resolution image + + This is an old option only available via the read method, not via + array-style slicing. + """ j = Jp2k(self.j2kfile) - thumbnail1 = j.read(rlevel=-1) - thumbnail2 = j.read(rlevel=5) + if sys.hexversion < 0x03000000: + with warnings.catch_warnings(): + # Suppress a warning due to deprecated syntax + # Not as easy to verify the warning under python2. + warnings.simplefilter("ignore") + thumbnail1 = j.read(rlevel=-1) + else: + with self.assertWarns(DeprecationWarning): + thumbnail1 = j.read(rlevel=-1) + thumbnail2 = j[::32, ::32] np.testing.assert_array_equal(thumbnail1, thumbnail2) self.assertEqual(thumbnail1.shape, (25, 15, 3)) + @unittest.skipIf(OPENJPEG_NOT_AVAILABLE, OPENJPEG_NOT_AVAILABLE_MSG) def test_rlevel_too_high(self): """Should error out appropriately if reduce level too high""" j = Jp2k(self.jp2file) with self.assertRaises(IOError): - j.read(rlevel=6) + j[::64, ::64] def test_not_jpeg2000(self): """Should error out appropriately if not given a JPEG 2000 file.""" @@ -199,7 +444,7 @@ class TestJp2k(unittest.TestCase): jp2k = Jp2k(self.j2kfile) self.assertEqual(len(jp2k.box), 0) - @unittest.skipIf(os.name == "nt", "NamedTemporaryFile issue on windows") + @unittest.skipIf(os.name == "nt", fixtures.WINDOWS_TMP_FILE_MSG) def test_64bit_xl_field(self): """XL field should be supported""" # Verify that boxes with the XL field are properly read. @@ -233,7 +478,7 @@ class TestJp2k(unittest.TestCase): self.assertEqual(jp2k.box[4].offset, 3223) self.assertEqual(jp2k.box[4].length, 1133427 + 8) - @unittest.skipIf(os.name == "nt", "NamedTemporaryFile issue on windows") + @unittest.skipIf(os.name == "nt", fixtures.WINDOWS_TMP_FILE_MSG) def test_length_field_is_zero(self): """L=0 (length field in box header) is allowed""" # Verify that boxes with the L field as zero are correctly read. @@ -269,19 +514,21 @@ class TestJp2k(unittest.TestCase): self.assertEqual(new_jp2.box[j].length, baseline_jp2.box[j].length) + @unittest.skipIf(OPENJPEG_NOT_AVAILABLE, OPENJPEG_NOT_AVAILABLE_MSG) def test_basic_jp2(self): """Just a very basic test that reading a JP2 file does not error out. """ j2k = Jp2k(self.jp2file) - j2k.read(rlevel=1) + j2k[::2, ::2] + @unittest.skipIf(OPENJPEG_NOT_AVAILABLE, OPENJPEG_NOT_AVAILABLE_MSG) def test_basic_j2k(self): """This test is only useful when openjp2 is not available and OPJ_DATA_ROOT is not set. We need at least one working J2K test. """ j2k = Jp2k(self.j2kfile) - j2k.read() + j2k[:] def test_empty_box_with_j2k(self): """Verify that the list of boxes in a J2C/J2K file is present, but @@ -290,7 +537,7 @@ class TestJp2k(unittest.TestCase): j = Jp2k(self.j2kfile) self.assertEqual(j.box, []) - @unittest.skipIf(os.name == "nt", "NamedTemporaryFile issue on windows") + @unittest.skipIf(os.name == "nt", fixtures.WINDOWS_TMP_FILE_MSG) def test_uinf_ulst_url_boxes(self): """Verify that we can read UINF, ULST, and URL boxes""" # Verify that we can read UINF, ULST, and URL boxes. I don't have @@ -349,7 +596,7 @@ class TestJp2k(unittest.TestCase): self.assertEqual(jp2k.box[3].box[1].flag, (0, 0, 0)) self.assertEqual(jp2k.box[3].box[1].url, 'abcd') - @unittest.skipIf(os.name == "nt", "NamedTemporaryFile issue on windows") + @unittest.skipIf(os.name == "nt", fixtures.WINDOWS_TMP_FILE_MSG) def test_xml_with_trailing_nulls(self): """ElementTree doesn't like trailing null chars after valid XML text""" with tempfile.NamedTemporaryFile(suffix='.jp2') as tfile: @@ -380,7 +627,7 @@ class TestJp2k(unittest.TestCase): self.assertEqual(ET.tostring(jp2k.box[3].xml.getroot()), b'this is a test') - @unittest.skipIf(not HAS_PYTHON_XMP_TOOLKIT, + @unittest.skipIf(not HAS_PYTHON_XMP_TOOLKIT, "Requires Python XMP Toolkit >= 2.0") def test_xmp_attribute(self): """Verify the XMP packet in the shipping example file can be read.""" @@ -396,9 +643,11 @@ class TestJp2k(unittest.TestCase): xmp = XMPMeta() xmp.parse_from_str(j.box[3].raw_data.decode('utf-8'), xmpmeta_wrap=False) - creator_tool = xmp.get_property(libxmp.consts.XMP_NS_XMP, 'CreatorTool') - self.assertEqual(creator_tool, 'Google') + creator_tool = xmp.get_property(libxmp.consts.XMP_NS_XMP, + 'CreatorTool') + self.assertEqual(creator_tool, 'Google') + @unittest.skipIf(OPENJPEG_NOT_AVAILABLE, OPENJPEG_NOT_AVAILABLE_MSG) @unittest.skipIf(re.match(r'''(1|2.0.0)''', glymur.version.openjpeg_version) is not None, "Not supported until 2.0.1") @@ -406,11 +655,20 @@ class TestJp2k(unittest.TestCase): """Read JPX codestream when jp2-compatible.""" # The file in question has multiple codestreams. jpx = Jp2k(self.jpxfile) - data = jpx.read() + data = jpx[:] self.assertEqual(data.shape, (1024, 1024, 3)) + def test_read_bands_without_openjp2(self): + """Don't have openjp2 library? Must error out.""" + with patch('glymur.version.openjpeg_version_tuple', new=(1, 5, 0)): + with self.assertRaises(RuntimeError): + glymur.Jp2k(self.jp2file).read_bands() -@unittest.skipIf(os.name == "nt", "NamedTemporaryFile issue on windows") + +@unittest.skipIf(OPENJPEG_NOT_AVAILABLE, OPENJPEG_NOT_AVAILABLE_MSG) +@unittest.skipIf(re.match('1.[0-4]', openjpeg_version) is not None, + "Not supported with OpenJPEG {0}".format(openjpeg_version)) +@unittest.skipIf(os.name == "nt", fixtures.WINDOWS_TMP_FILE_MSG) class TestJp2k_write(unittest.TestCase): """Write tests, can be run by versions 1.5+""" @@ -421,17 +679,54 @@ class TestJp2k_write(unittest.TestCase): def tearDown(self): pass + def test_precinct_size_too_small(self): + """first precinct size must be >= 2x that of the code block size""" + data = np.zeros((640, 480), dtype=np.uint8) + with tempfile.NamedTemporaryFile(suffix='.j2k') as tfile: + with self.assertRaises(IOError): + Jp2k(tfile.name, data=data, + cbsize=(16, 16), psizes=[(16, 16)]) + + def test_precinct_size_not_power_of_two(self): + """must be power of two""" + data = np.zeros((640, 480), dtype=np.uint8) + with tempfile.NamedTemporaryFile(suffix='.j2k') as tfile: + with self.assertRaises(IOError): + Jp2k(tfile.name, data=data, + cbsize=(16, 16), psizes=[(48, 48)]) + + def test_unsupported_int32(self): + """Should raise a runtime error if trying to write int32""" + data = np.zeros((128, 128), dtype=np.int32) + with tempfile.NamedTemporaryFile(suffix='.j2k') as tfile: + with self.assertRaises(RuntimeError): + Jp2k(tfile.name, data=data) + + def test_unsupported_uint32(self): + """Should raise a runtime error if trying to write uint32""" + data = np.zeros((128, 128), dtype=np.uint32) + with tempfile.NamedTemporaryFile(suffix='.j2k') as tfile: + with self.assertRaises(RuntimeError): + Jp2k(tfile.name, data=data) + + def test_write_with_version_too_early(self): + """Should raise a runtime error if trying to write with version 1.3""" + data = np.zeros((128, 128), dtype=np.uint8) + versions = ["1.0.0", "1.1.0", "1.2.0", "1.3.0"] + for version in versions: + with patch('glymur.version.openjpeg_version', new=version): + with tempfile.NamedTemporaryFile(suffix='.j2k') as tfile: + with self.assertRaises(RuntimeError): + Jp2k(tfile.name, data=data) + def test_cblkh_different_than_width(self): """Verify that we can set a code block size where height does not equal width. """ data = np.zeros((128, 128), dtype=np.uint8) with tempfile.NamedTemporaryFile(suffix='.j2k') as tfile: - j = Jp2k(tfile.name, 'wb') - # The code block dimensions are given as rows x columns. - j.write(data, cbsize=(16, 32)) - + j = Jp2k(tfile.name, data=data, cbsize=(16, 32)) codestream = j.get_codestream() # Code block size is reported as XY in the codestream. @@ -440,59 +735,55 @@ class TestJp2k_write(unittest.TestCase): def test_too_many_dimensions(self): """OpenJP2 only allows 2D or 3D images.""" with tempfile.NamedTemporaryFile(suffix='.j2k') as tfile: - j = Jp2k(tfile.name, 'wb') with self.assertRaises(IOError): - data = np.zeros((128, 128, 2, 2), dtype=np.uint8) - j.write(data) + Jp2k(tfile.name, + data=np.zeros((128, 128, 2, 2), dtype=np.uint8)) def test_2d_rgb(self): """RGB must have at least 3 components.""" with tempfile.NamedTemporaryFile(suffix='.jp2') as tfile: - j = Jp2k(tfile.name, 'wb') with self.assertRaises(IOError): - data = np.zeros((128, 128, 2), dtype=np.uint8) - j.write(data, colorspace='rgb') + Jp2k(tfile.name, + data=np.zeros((128, 128, 2), dtype=np.uint8), + colorspace='rgb') def test_colorspace_with_j2k(self): """Specifying a colorspace with J2K does not make sense""" with tempfile.NamedTemporaryFile(suffix='.j2k') as tfile: - j = Jp2k(tfile.name, 'wb') with self.assertRaises(IOError): - data = np.zeros((128, 128, 3), dtype=np.uint8) - j.write(data, colorspace='rgb') + Jp2k(tfile.name, + data=np.zeros((128, 128, 3), dtype=np.uint8), + colorspace='rgb') def test_specify_rgb(self): """specify RGB explicitly""" with tempfile.NamedTemporaryFile(suffix='.jp2') as tfile: - j = Jp2k(tfile.name, 'wb') - data = np.zeros((128, 128, 3), dtype=np.uint8) - j.write(data, colorspace='rgb') + j = Jp2k(tfile.name, + data=np.zeros((128, 128, 3), dtype=np.uint8), + colorspace='rgb') self.assertEqual(j.box[2].box[1].colorspace, glymur.core.SRGB) def test_specify_gray(self): """test gray explicitly specified (that's GRAY, not GREY)""" with tempfile.NamedTemporaryFile(suffix='.jp2') as tfile: - j = Jp2k(tfile.name, 'wb') data = np.zeros((128, 128), dtype=np.uint8) - j.write(data, colorspace='gray') + j = Jp2k(tfile.name, data=data, colorspace='gray') self.assertEqual(j.box[2].box[1].colorspace, glymur.core.GREYSCALE) def test_specify_grey(self): """test grey explicitly specified""" with tempfile.NamedTemporaryFile(suffix='.jp2') as tfile: - j = Jp2k(tfile.name, 'wb') data = np.zeros((128, 128), dtype=np.uint8) - j.write(data, colorspace='grey') + j = Jp2k(tfile.name, data=data, colorspace='grey') self.assertEqual(j.box[2].box[1].colorspace, glymur.core.GREYSCALE) def test_grey_with_two_extra_comps(self): """should be able to write gray + two extra components""" with tempfile.NamedTemporaryFile(suffix='.jp2') as tfile: - j = Jp2k(tfile.name, 'wb') data = np.zeros((128, 128, 3), dtype=np.uint8) - j.write(data, colorspace='gray') + j = Jp2k(tfile.name, data=data, colorspace='gray') self.assertEqual(j.box[2].box[0].height, 128) self.assertEqual(j.box[2].box[0].width, 128) self.assertEqual(j.box[2].box[0].num_components, 3) @@ -502,29 +793,26 @@ class TestJp2k_write(unittest.TestCase): def test_specify_ycc(self): """Should reject YCC""" with tempfile.NamedTemporaryFile(suffix='.jp2') as tfile: - j = Jp2k(tfile.name, 'wb') with self.assertRaises(IOError): data = np.zeros((128, 128, 3), dtype=np.uint8) - j.write(data, colorspace='ycc') + Jp2k(tfile.name, data=data, colorspace='ycc') def test_write_with_jp2_in_caps(self): """should be able to write with JP2 suffix.""" j2k = Jp2k(self.j2kfile) - expdata = j2k.read() + expdata = j2k[:] with tempfile.NamedTemporaryFile(suffix='.JP2') as tfile: - ofile = Jp2k(tfile.name, 'wb') - ofile.write(expdata) - actdata = ofile.read() + ofile = Jp2k(tfile.name, data=expdata) + actdata = ofile[:] np.testing.assert_array_equal(actdata, expdata) def test_write_srgb_without_mct(self): """should be able to write RGB without specifying mct""" j2k = Jp2k(self.j2kfile) - expdata = j2k.read() + expdata = j2k[:] with tempfile.NamedTemporaryFile(suffix='.jp2') as tfile: - ofile = Jp2k(tfile.name, 'wb') - ofile.write(expdata, mct=False) - actdata = ofile.read() + ofile = Jp2k(tfile.name, data=expdata, mct=False) + actdata = ofile[:] np.testing.assert_array_equal(actdata, expdata) codestream = ofile.get_codestream() @@ -533,29 +821,25 @@ class TestJp2k_write(unittest.TestCase): def test_write_grayscale_with_mct(self): """MCT usage makes no sense for grayscale images.""" j2k = Jp2k(self.j2kfile) - expdata = j2k.read() + expdata = j2k[:] with tempfile.NamedTemporaryFile(suffix='.jp2') as tfile: - ofile = Jp2k(tfile.name, 'wb') with self.assertRaises(IOError): - ofile.write(expdata[:, :, 0], mct=True) + Jp2k(tfile.name, data=expdata[:, :, 0], mct=True) def test_write_cprl(self): """Must be able to write a CPRL progression order file""" # Issue 17 j = Jp2k(self.jp2file) - expdata = j.read(rlevel=1) + expdata = j[::2, ::2] with tempfile.NamedTemporaryFile(suffix='.jp2') as tfile: - ofile = Jp2k(tfile.name, 'wb') - ofile.write(expdata, prog='CPRL') - actdata = ofile.read() + ofile = Jp2k(tfile.name, data=expdata, prog='CPRL') + actdata = ofile[:] np.testing.assert_array_equal(actdata, expdata) codestream = ofile.get_codestream() self.assertEqual(codestream.segment[2].spcod[0], glymur.core.CPRL) -@unittest.skipIf(glymur.version.openjpeg_version_tuple[0] >= 2, - "Negative tests only for version 1.x") class TestJp2k_1_x(unittest.TestCase): """Test suite for openjpeg 1.x, not appropriate for 2.x""" @@ -566,42 +850,38 @@ class TestJp2k_1_x(unittest.TestCase): def tearDown(self): pass - def test_area(self): - """Area option not allowed for 1.x. - """ - j2k = Jp2k(self.j2kfile) - with self.assertRaises(TypeError): - j2k.read(area=(0, 0, 100, 100)) - def test_tile(self): """tile option not allowed for 1.x. """ - j2k = Jp2k(self.j2kfile) - with self.assertRaises(TypeError): - j2k.read(tile=0) + with patch('glymur.version.openjpeg_version_tuple', new=(1, 5, 0)): + j2k = Jp2k(self.j2kfile) + with warnings.catch_warnings(): + # The tile keyword is deprecated, so suppress the warning. + warnings.simplefilter('ignore') + with self.assertRaises(TypeError): + j2k.read(tile=0) def test_layer(self): """layer option not allowed for 1.x. """ - j2k = Jp2k(self.j2kfile) - with self.assertRaises(TypeError): - j2k.read(layer=1) + with patch('glymur.version.openjpeg_version_tuple', new=(1, 5, 0)): + j2k = Jp2k(self.j2kfile) + with self.assertRaises(RuntimeError): + j2k.layer = 1 -@unittest.skipIf(re.match(r'''2.0.0''', - glymur.version.openjpeg_version) is None, - "Tests only to be run on 2.0 official.") -class TestJp2k_2_0_official(unittest.TestCase): - """Test suite to only be run on v2.0 official.""" +@unittest.skipIf(os.name == "nt", fixtures.WINDOWS_TMP_FILE_MSG) +@unittest.skipIf(OPENJPEG_NOT_AVAILABLE, OPENJPEG_NOT_AVAILABLE_MSG) +class Test_2p0_official(unittest.TestCase): + """Tests specific to v2.0.0""" - @unittest.skipIf(os.name == "nt", "NamedTemporaryFile issue on windows") def test_extra_components_on_v2(self): """Can only write 4 components on 2.0+, should error out otherwise.""" - with tempfile.NamedTemporaryFile(suffix='.jp2') as tfile: - j = Jp2k(tfile.name, 'wb') - data = np.zeros((128, 128, 4), dtype=np.uint8) - with self.assertRaises(IOError): - j.write(data) + with patch('glymur.version.openjpeg_version', new="2.0.0"): + with tempfile.NamedTemporaryFile(suffix='.jp2') as tfile: + data = np.zeros((128, 128, 4), dtype=np.uint8) + with self.assertRaises(IOError): + Jp2k(tfile.name, data=data) @unittest.skipIf(glymur.version.openjpeg_version_tuple[0] < 2, @@ -621,32 +901,30 @@ class TestJp2k_2_0(unittest.TestCase): j = Jp2k(self.jp2file) with self.assertRaises(IOError): # Start corner must be >= 0 - j.read(area=(-1, -1, 1, 1)) + j[-1:1, -1:1] with self.assertRaises(IOError): # End corner must be > 0 - j.read(area=(10, 10, 0, 0)) + j[10:0, 10:0] with self.assertRaises(IOError): # End corner must be >= start corner - j.read(area=(10, 10, 8, 8)) + j[10:8, 10:8] - @unittest.skipIf(os.name == "nt", "NamedTemporaryFile issue on windows") + @unittest.skipIf(os.name == "nt", fixtures.WINDOWS_TMP_FILE_MSG) def test_unrecognized_jp2_clrspace(self): """We only allow RGB and GRAYSCALE. Should error out with others""" with tempfile.NamedTemporaryFile(suffix='.jp2') as tfile: - j = Jp2k(tfile.name, 'wb') + data = np.zeros((128, 128, 3), dtype=np.uint8) with self.assertRaises(IOError): - data = np.zeros((128, 128, 3), dtype=np.uint8) - j.write(data, colorspace='cmyk') + Jp2k(tfile.name, data=data, colorspace='cmyk') - @unittest.skipIf(os.name == "nt", "NamedTemporaryFile issue on windows") + @unittest.skipIf(os.name == "nt", fixtures.WINDOWS_TMP_FILE_MSG) def test_asoc_label_box(self): """Test asoc and label box""" # Construct a fake file with an asoc and a label box, as # OpenJPEG doesn't have such a file. - data = Jp2k(self.jp2file).read(rlevel=1) + data = Jp2k(self.jp2file)[::2, ::2] with tempfile.NamedTemporaryFile(suffix='.jp2') as tfile: - j = Jp2k(tfile.name, 'wb') - j.write(data) + Jp2k(tfile.name, data=data) with tempfile.NamedTemporaryFile(suffix='.jp2') as tfile2: @@ -687,6 +965,7 @@ class TestJp2k_2_0(unittest.TestCase): self.assertEqual(jasoc.box[3].box[1].box_id, 'xml ') +@unittest.skipIf(OPENJPEG_NOT_AVAILABLE, OPENJPEG_NOT_AVAILABLE_MSG) @unittest.skipIf(re.match(r'''(1|2.0.0)''', glymur.version.openjpeg_version) is not None, "Not to be run until unless 2.0.1 or higher is present") @@ -700,32 +979,31 @@ class TestJp2k_2_1(unittest.TestCase): def tearDown(self): pass - @unittest.skipIf(os.name == "nt", "NamedTemporaryFile issue on windows") + @unittest.skipIf(os.name == "nt", fixtures.WINDOWS_TMP_FILE_MSG) def test_grey_with_extra_component(self): """version 2.0 cannot write gray + extra""" with tempfile.NamedTemporaryFile(suffix='.jp2') as tfile: - j = Jp2k(tfile.name, 'wb') data = np.zeros((128, 128, 2), dtype=np.uint8) - j.write(data) + j = Jp2k(tfile.name, data=data) self.assertEqual(j.box[2].box[0].height, 128) self.assertEqual(j.box[2].box[0].width, 128) self.assertEqual(j.box[2].box[0].num_components, 2) self.assertEqual(j.box[2].box[1].colorspace, glymur.core.GREYSCALE) - @unittest.skipIf(os.name == "nt", "NamedTemporaryFile issue on windows") + @unittest.skipIf(os.name == "nt", fixtures.WINDOWS_TMP_FILE_MSG) def test_rgb_with_extra_component(self): """v2.0+ should be able to write extra components""" with tempfile.NamedTemporaryFile(suffix='.jp2') as tfile: - j = Jp2k(tfile.name, 'wb') data = np.zeros((128, 128, 4), dtype=np.uint8) - j.write(data) + j = Jp2k(tfile.name, data=data) self.assertEqual(j.box[2].box[0].height, 128) self.assertEqual(j.box[2].box[0].width, 128) self.assertEqual(j.box[2].box[0].num_components, 4) self.assertEqual(j.box[2].box[1].colorspace, glymur.core.SRGB) - @unittest.skipIf(os.name == "nt", "NamedTemporaryFile issue on windows") + @unittest.skipIf(WARNING_INFRASTRUCTURE_ISSUE, WARNING_INFRASTRUCTURE_MSG) + @unittest.skipIf(os.name == "nt", fixtures.WINDOWS_TMP_FILE_MSG) def test_openjpeg_library_message(self): """Verify the error message produced by the openjpeg library""" # This will confirm that the error callback mechanism is working. @@ -743,24 +1021,25 @@ class TestJp2k_2_1(unittest.TestCase): tfile.write(data[offset+53:offset+55]) tfile.write(b'\x00') tfile.write(data[offset+57:offset+59]) - #tfile.write(data[3184:3186]) tfile.write(b'\x00') tfile.write(data[offset+59:]) - #tfile.write(data[3186:]) tfile.flush() with warnings.catch_warnings(): - warnings.simplefilter("ignore") + warnings.simplefilter('ignore') j = Jp2k(tfile.name) - regexp = re.compile(r'''OpenJPEG\slibrary\serror:\s+ - Invalid\svalues\sfor\scomp\s=\s0\s+ - :\sdx=1\sdy=0''', re.VERBOSE) - if sys.hexversion < 0x03020000: - with self.assertRaisesRegexp((IOError, OSError), regexp): - j.read(rlevel=1) - else: - with self.assertRaisesRegex((IOError, OSError), regexp): - j.read(rlevel=1) + regexp = re.compile(r'''OpenJPEG\slibrary\serror:\s+ + Invalid\svalues\sfor\scomp\s=\s0\s+ + :\sdx=1\sdy=0''', re.VERBOSE) + if sys.hexversion < 0x03020000: + with self.assertRaisesRegexp((IOError, OSError), + regexp): + j[::2, ::2] + else: + with self.assertRaisesRegex((IOError, OSError), + regexp): + j[::2, ::2] + @unittest.skipIf(OPJ_DATA_ROOT is None, "OPJ_DATA_ROOT environment variable not set") @@ -769,37 +1048,33 @@ class TestParsing(unittest.TestCase): def setUp(self): self.jp2file = glymur.data.nemo() # Reset parseoptions for every test. - glymur.set_parseoptions(codestream=True) + glymur.set_parseoptions(full_codestream=False) def tearDown(self): - pass + glymur.set_parseoptions(full_codestream=False) - @unittest.skipIf(sys.platform.startswith('linux'), 'Failing on linux') + @unittest.skipIf(WARNING_INFRASTRUCTURE_ISSUE, WARNING_INFRASTRUCTURE_MSG) def test_bad_rsiz(self): """Should not warn if RSIZ when parsing is turned off.""" - # Actually there are three warning triggered by this codestream. filename = opj_data_file('input/nonregression/edf_c2_1002767.jp2') - glymur.set_parseoptions(codestream=False) - with warnings.catch_warnings(record=True) as w: - j = Jp2k(filename) - self.assertEqual(len(w), 0) + glymur.set_parseoptions(full_codestream=False) + Jp2k(filename) - glymur.set_parseoptions(codestream=True) - with warnings.catch_warnings(record=True) as w: - jp2 = Jp2k(filename) - self.assertTrue(issubclass(w[0].category, UserWarning)) - self.assertTrue('Invalid profile' in str(w[0].message)) + glymur.set_parseoptions(full_codestream=True) + with self.assertWarnsRegex(UserWarning, 'Invalid profile'): + Jp2k(filename) def test_main_header(self): - """Verify that the main header is not loaded when parsing turned off.""" + """verify that the main header isn't loaded during normal parsing""" # The hidden _main_header attribute should show up after accessing it. - glymur.set_parseoptions(codestream=False) jp2 = Jp2k(self.jp2file) jp2c = jp2.box[4] - self.assertIsNone(jp2c._main_header) - main_header = jp2c.main_header - self.assertIsNotNone(jp2c._main_header) + self.assertIsNone(jp2c._codestream) + jp2c.codestream + self.assertIsNotNone(jp2c._codestream) + +@unittest.skipIf(WARNING_INFRASTRUCTURE_ISSUE, WARNING_INFRASTRUCTURE_MSG) @unittest.skipIf(OPJ_DATA_ROOT is None, "OPJ_DATA_ROOT environment variable not set") class TestJp2kOpjDataRootWarnings(unittest.TestCase): @@ -808,11 +1083,8 @@ class TestJp2kOpjDataRootWarnings(unittest.TestCase): def test_undecodeable_box_id(self): """Should warn in case of undecodeable box ID but not error out.""" filename = opj_data_file('input/nonregression/edf_c2_1013627.jp2') - with warnings.catch_warnings(record=True) as w: - warnings.simplefilter('always') + with self.assertWarnsRegex(UserWarning, 'Unrecognized box'): jp2 = Jp2k(filename) - self.assertTrue(issubclass(w[0].category, UserWarning)) - self.assertTrue('Unrecognized box' in str(w[0].message)) # Now make sure we got all of the boxes. Ignore the last, which was # bad. @@ -822,73 +1094,70 @@ class TestJp2kOpjDataRootWarnings(unittest.TestCase): def test_bad_ftyp_brand(self): """Should warn in case of bad ftyp brand.""" filename = opj_data_file('input/nonregression/edf_c2_1000290.jp2') - with warnings.catch_warnings(record=True) as w: - warnings.simplefilter('always') - jp2 = Jp2k(filename) - self.assertTrue(issubclass(w[0].category, UserWarning)) + with self.assertWarns(UserWarning): + Jp2k(filename) def test_invalid_approximation(self): """Should warn in case of invalid approximation.""" filename = opj_data_file('input/nonregression/edf_c2_1015644.jp2') - with warnings.catch_warnings(record=True) as w: - warnings.simplefilter('always') - jp2 = Jp2k(filename) - self.assertTrue(issubclass(w[0].category, UserWarning)) - self.assertTrue('Invalid approximation' in str(w[0].message)) + with self.assertWarnsRegex(UserWarning, 'Invalid approximation'): + Jp2k(filename) - @unittest.skipIf(sys.platform.startswith('linux'), 'Failing on linux') def test_invalid_colorspace(self): - """Should warn in case of invalid colorspace.""" + """ + Should warn in case of invalid colorspace. + + There are multiple warnings, so there's no good way to regex them all. + """ filename = opj_data_file('input/nonregression/edf_c2_1103421.jp2') - with warnings.catch_warnings(record=True) as w: - warnings.simplefilter('always') - jp2 = Jp2k(filename) - self.assertTrue(issubclass(w[1].category, UserWarning)) - self.assertTrue('Unrecognized colorspace' in str(w[1].message)) + with self.assertWarns(UserWarning): + Jp2k(filename) def test_stupid_windows_eol_at_end(self): """Garbage characters at the end of the file.""" filename = opj_data_file('input/nonregression/issue211.jp2') - with warnings.catch_warnings(record=True) as w: - warnings.simplefilter('always') - jp2 = Jp2k(filename) - self.assertTrue(issubclass(w[1].category, UserWarning)) + with self.assertWarns(UserWarning): + Jp2k(filename) @unittest.skipIf(OPJ_DATA_ROOT is None, "OPJ_DATA_ROOT environment variable not set") class TestJp2kOpjDataRoot(unittest.TestCase): - """These tests should be run by just about all configuration.""" + """These tests should be run by just about all configurations.""" - @unittest.skipIf(os.name == "nt", "NamedTemporaryFile issue on windows") + @unittest.skipIf(re.match("0|1.[0-4]", glymur.version.openjpeg_version), + "Must have openjpeg 1.5 or higher to run") + @unittest.skipIf(os.name == "nt", fixtures.WINDOWS_TMP_FILE_MSG) def test_irreversible(self): """Irreversible""" filename = opj_data_file('input/nonregression/issue141.rawl') expdata = np.fromfile(filename, dtype=np.uint16) - expdata.resize((2816, 2048)) + expdata.resize((32, 2048)) with tempfile.NamedTemporaryFile(suffix='.j2k') as tfile: - j = Jp2k(tfile.name, 'wb') - j.write(expdata, irreversible=True) + j = Jp2k(tfile.name, data=expdata, irreversible=True, numres=5) codestream = j.get_codestream() self.assertEqual(codestream.segment[2].spcod[8], glymur.core.WAVELET_XFORM_9X7_IRREVERSIBLE) - actdata = j.read() + actdata = j[:] self.assertTrue(fixtures.mse(actdata, expdata) < 250) + @unittest.skipIf(WARNING_INFRASTRUCTURE_ISSUE, WARNING_INFRASTRUCTURE_MSG) def test_no_cxform_pclr_jp2(self): """Indices for pclr jpxfile if no color transform""" filename = opj_data_file('input/conformance/file9.jp2') - j = Jp2k(filename) - rgb = j.read() - idx = j.read(ignore_pclr_cmap_cdef=True) + with self.assertWarns(UserWarning): + jp2 = Jp2k(filename) + rgb = jp2[:] + jp2.ignore_pclr_cmap_cdef = True + idx = jp2[:] self.assertEqual(rgb.shape, (512, 768, 3)) self.assertEqual(idx.shape, (512, 768)) # Should be able to manually reconstruct the RGB image from the palette # and indices. - palette = j.box[2].box[1].palette + palette = jp2.box[2].box[1].palette rgb_from_idx = np.zeros(rgb.shape, dtype=np.uint8) for r in np.arange(rgb.shape[0]): for c in np.arange(rgb.shape[1]): @@ -904,27 +1173,161 @@ class TestJp2kOpjDataRoot(unittest.TestCase): filename = opj_data_file('input/conformance/p0_05.j2k') j = Jp2k(filename) with self.assertRaises(RuntimeError): - j.read() + j[:] + @unittest.skipIf(WARNING_INFRASTRUCTURE_ISSUE, WARNING_INFRASTRUCTURE_MSG) def test_no_cxform_cmap(self): """Bands as physically ordered, not as physically intended""" # This file has the components physically reversed. The cmap box # tells the decoder how to order them, but this flag prevents that. filename = opj_data_file('input/conformance/file2.jp2') - with warnings.catch_warnings(): + with self.assertWarns(UserWarning): # The file has a bad compatibility list entry. Not important here. - warnings.simplefilter("ignore") j = Jp2k(filename) - ycbcr = j.read() - crcby = j.read(ignore_pclr_cmap_cdef=True) + ycbcr = j[:] + j.ignore_pclr_cmap_cdef = True + crcby = j[:] expected = np.zeros(ycbcr.shape, ycbcr.dtype) for k in range(crcby.shape[2]): - expected[:,:,crcby.shape[2] - k - 1] = crcby[:,:,k] + expected[:, :, crcby.shape[2] - k - 1] = crcby[:, :, k] np.testing.assert_array_equal(ycbcr, expected) +@unittest.skipIf(OPJ_DATA_ROOT is None, + "OPJ_DATA_ROOT environment variable not set") +class TestCodestreamOpjData(unittest.TestCase): + """Test suite for unusual codestream cases. Uses OPJ_DATA_ROOT""" -if __name__ == "__main__": - unittest.main() + def setUp(self): + self.jp2file = glymur.data.nemo() + + def tearDown(self): + pass + + @unittest.skipIf(os.name == "nt", "Temporary file issue on window.") + def test_reserved_marker_segment(self): + """Reserved marker segments are ok.""" + + # Some marker segments were reserved in FCD15444-1. Since that + # standard is old, some of them may have come into use. + # + # Let's inject a reserved marker segment into a file that + # we know something about to make sure we can still parse it. + filename = os.path.join(OPJ_DATA_ROOT, 'input/conformance/p0_01.j2k') + with tempfile.NamedTemporaryFile(suffix='.j2k') as tfile: + with open(filename, 'rb') as ifile: + # Everything up until the first QCD marker. + read_buffer = ifile.read(45) + tfile.write(read_buffer) + + # Write the new marker segment, 0xff6f = 65391 + read_buffer = struct.pack('>HHB', int(65391), int(3), int(0)) + tfile.write(read_buffer) + + # Get the rest of the input file. + read_buffer = ifile.read() + tfile.write(read_buffer) + tfile.flush() + + codestream = Jp2k(tfile.name).get_codestream() + + self.assertEqual(codestream.segment[2].marker_id, '0xff6f') + self.assertEqual(codestream.segment[2].length, 3) + self.assertEqual(codestream.segment[2].data, b'\x00') + + def test_psot_is_zero(self): + """Psot=0 in SOT is perfectly legal. Issue #78.""" + filename = os.path.join(OPJ_DATA_ROOT, + 'input/nonregression/123.j2c') + j = Jp2k(filename) + codestream = j.get_codestream(header_only=False) + + # The codestream is valid, so we should be able to get the entire + # codestream, so the last one is EOC. + self.assertEqual(codestream.segment[-1].marker_id, 'EOC') + + def test_siz_segment_ssiz_signed(self): + """ssiz attribute to be removed in future release""" + filename = os.path.join(OPJ_DATA_ROOT, 'input/conformance/p0_03.j2k') + j = Jp2k(filename) + codestream = j.get_codestream() + + # The ssiz attribute was simply a tuple of raw bytes. + # The first 7 bits are interpreted as the bitdepth, the MSB determines + # whether or not it is signed. + self.assertEqual(codestream.segment[1].ssiz, (131,)) + + +class TestCodestreamRepr(unittest.TestCase): + + def setUp(self): + self.jp2file = glymur.data.nemo() + + def tearDown(self): + pass + + def test_soc(self): + """Test SOC segment repr""" + segment = glymur.codestream.SOCsegment() + newseg = eval(repr(segment)) + self.assertEqual(newseg.marker_id, 'SOC') + + def test_siz(self): + """Test SIZ segment repr""" + kwargs = {'rsiz': 0, + 'xysiz': (2592, 1456), + 'xyosiz': (0, 0), + 'xytsiz': (2592, 1456), + 'xytosiz': (0, 0), + 'Csiz': 3, + 'bitdepth': (8, 8, 8), + 'signed': (False, False, False), + 'xyrsiz': ((1, 1, 1), (1, 1, 1))} + segment = glymur.codestream.SIZsegment(**kwargs) + newseg = eval(repr(segment)) + self.assertEqual(newseg.marker_id, 'SIZ') + self.assertEqual(newseg.xsiz, 2592) + self.assertEqual(newseg.ysiz, 1456) + self.assertEqual(newseg.xosiz, 0) + self.assertEqual(newseg.yosiz, 0) + self.assertEqual(newseg.xtsiz, 2592) + self.assertEqual(newseg.ytsiz, 1456) + self.assertEqual(newseg.xtosiz, 0) + self.assertEqual(newseg.ytosiz, 0) + + self.assertEqual(newseg.xrsiz, (1, 1, 1)) + self.assertEqual(newseg.yrsiz, (1, 1, 1)) + self.assertEqual(newseg.bitdepth, (8, 8, 8)) + self.assertEqual(newseg.signed, (False, False, False)) + + def test_siz_segment_ssiz_unsigned(self): + """ssiz attribute to be removed in future release""" + j = Jp2k(self.jp2file) + codestream = j.get_codestream() + + # The ssiz attribute was simply a tuple of raw bytes. + # The first 7 bits are interpreted as the bitdepth, the MSB determines + # whether or not it is signed. + self.assertEqual(codestream.segment[1].ssiz, (7, 7, 7)) + + +class TestCodestream(unittest.TestCase): + """Test suite for unusual codestream cases.""" + + def setUp(self): + self.jp2file = glymur.data.nemo() + + def tearDown(self): + pass + + def test_siz_segment_ssiz_unsigned(self): + """ssiz attribute to be removed in future release""" + j = Jp2k(self.jp2file) + codestream = j.get_codestream() + + # The ssiz attribute was simply a tuple of raw bytes. + # The first 7 bits are interpreted as the bitdepth, the MSB determines + # whether or not it is signed. + self.assertEqual(codestream.segment[1].ssiz, (7, 7, 7)) diff --git a/glymur/test/test_opj_suite.py b/glymur/test/test_opj_suite.py index 1e658a3..9e8a0eb 100644 --- a/glymur/test/test_opj_suite.py +++ b/glymur/test/test_opj_suite.py @@ -2,49 +2,25 @@ The tests defined here roughly correspond to what is in the OpenJPEG test suite. """ - -# Some test names correspond with openjpeg tests. Long names are ok in this -# case. -# pylint: disable=C0103 - -# All of these tests correspond to tests in openjpeg, so no docstring is really -# needed. -# pylint: disable=C0111 - -# This module is very long, cannot be helped. -# pylint: disable=C0302 - -# unittest fools pylint with "too many public methods" -# pylint: disable=R0904 - -# Some tests use numpy test infrastructure, which means the tests never -# reference "self", so pylint claims it should be a function. No, no, no. -# pylint: disable=R0201 - -# Many tests are pretty long and that can't be helped. -# pylint: disable=R0915 - -# asserWarns introduced in python 3.2 (python2.7/pylint issue) -# pylint: disable=E1101 - import re import sys import unittest - import warnings import numpy as np -from glymur import Jp2k import glymur +from glymur import Jp2k +from glymur.jp2box import FileTypeBox, ImageHeaderBox, ColourSpecificationBox -from .fixtures import OPJ_DATA_ROOT -from .fixtures import mse, peak_tolerance, read_pgx, opj_data_file +from .fixtures import (OPJ_DATA_ROOT, MetadataBase, + WARNING_INFRASTRUCTURE_ISSUE, + WARNING_INFRASTRUCTURE_MSG, + mse, peak_tolerance, read_pgx, opj_data_file, + OPENJPEG_NOT_AVAILABLE, OPENJPEG_NOT_AVAILABLE_MSG) -@unittest.skipIf(glymur.lib.openjp2.OPENJP2 is None and - glymur.lib.openjpeg.OPENJPEG is None, - "Missing openjpeg libraries.") +@unittest.skipIf(OPENJPEG_NOT_AVAILABLE, OPENJPEG_NOT_AVAILABLE_MSG) @unittest.skipIf(OPJ_DATA_ROOT is None, "OPJ_DATA_ROOT environment variable not set") class TestSuite(unittest.TestCase): @@ -58,7 +34,7 @@ class TestSuite(unittest.TestCase): def test_ETS_C1P0_p0_01_j2k(self): jfile = opj_data_file('input/conformance/p0_01.j2k') jp2k = Jp2k(jfile) - jpdata = jp2k.read(rlevel=0) + jpdata = jp2k[:] pgxfile = opj_data_file('baseline/conformance/c1p0_01_0.pgx') pgxdata = read_pgx(pgxfile) @@ -68,7 +44,7 @@ class TestSuite(unittest.TestCase): def test_ETS_C1P0_p0_03_j2k(self): jfile = opj_data_file('input/conformance/p0_03.j2k') jp2k = Jp2k(jfile) - jpdata = jp2k.read(rlevel=0) + jpdata = jp2k[:] pgxfile = opj_data_file('baseline/conformance/c1p0_03_0.pgx') pgxdata = read_pgx(pgxfile) @@ -78,7 +54,7 @@ class TestSuite(unittest.TestCase): def test_ETS_C1P0_p0_04_j2k(self): jfile = opj_data_file('input/conformance/p0_04.j2k') jp2k = Jp2k(jfile) - jpdata = jp2k.read(rlevel=0) + jpdata = jp2k[:] pgxfile = opj_data_file('baseline/conformance/c1p0_04_0.pgx') pgxdata = read_pgx(pgxfile) @@ -95,28 +71,10 @@ class TestSuite(unittest.TestCase): self.assertTrue(peak_tolerance(jpdata[:, :, 2], pgxdata) < 6) self.assertTrue(mse(jpdata[:, :, 2], pgxdata) < 1.07) - @unittest.skip("Known failure in OPENJPEG test suite operation.") - def test_ETS_C1P0_p0_07_j2k(self): - jfile = opj_data_file('input/conformance/p0_07.j2k') - jp2k = Jp2k(jfile) - jpdata = jp2k.read() - - pgxfile = opj_data_file('baseline/conformance/c1p0_07_0.pgx') - pgxdata = read_pgx(pgxfile) - np.testing.assert_array_equal(jpdata[:, :, 0], pgxdata) - - pgxfile = opj_data_file('baseline/conformance/c1p0_07_1.pgx') - pgxdata = read_pgx(pgxfile) - np.testing.assert_array_equal(jpdata[:, : 1], pgxdata) - - pgxfile = opj_data_file('baseline/conformance/c1p0_07_2.pgx') - pgxdata = read_pgx(pgxfile) - np.testing.assert_array_equal(jpdata[:, : 2], pgxdata) - def test_ETS_C1P0_p0_08_j2k(self): jfile = opj_data_file('input/conformance/p0_08.j2k') jp2k = Jp2k(jfile) - jpdata = jp2k.read(rlevel=1) + jpdata = jp2k[::2, ::2] pgxfile = opj_data_file('baseline/conformance/c1p0_08_0.pgx') pgxdata = read_pgx(pgxfile) @@ -133,7 +91,7 @@ class TestSuite(unittest.TestCase): def test_ETS_C1P0_p0_09_j2k(self): jfile = opj_data_file('input/conformance/p0_09.j2k') jp2k = Jp2k(jfile) - jpdata = jp2k.read(rlevel=0) + jpdata = jp2k[:] pgxfile = opj_data_file('baseline/conformance/c1p0_09_0.pgx') pgxdata = read_pgx(pgxfile) @@ -142,7 +100,7 @@ class TestSuite(unittest.TestCase): def test_ETS_C1P0_p0_11_j2k(self): jfile = opj_data_file('input/conformance/p0_11.j2k') jp2k = Jp2k(jfile) - jpdata = jp2k.read(rlevel=0) + jpdata = jp2k[:] pgxfile = opj_data_file('baseline/conformance/c1p0_11_0.pgx') pgxdata = read_pgx(pgxfile) @@ -151,7 +109,7 @@ class TestSuite(unittest.TestCase): def test_ETS_C1P0_p0_14_j2k(self): jfile = opj_data_file('input/conformance/p0_14.j2k') jp2k = Jp2k(jfile) - jpdata = jp2k.read(rlevel=0) + jpdata = jp2k[:] pgxfile = opj_data_file('baseline/conformance/c1p0_14_0.pgx') pgxdata = read_pgx(pgxfile) @@ -168,7 +126,7 @@ class TestSuite(unittest.TestCase): def test_ETS_C1P0_p0_15_j2k(self): jfile = opj_data_file('input/conformance/p0_15.j2k') jp2k = Jp2k(jfile) - jpdata = jp2k.read(rlevel=0) + jpdata = jp2k[:] pgxfile = opj_data_file('baseline/conformance/c1p0_15_0.pgx') pgxdata = read_pgx(pgxfile) @@ -177,7 +135,7 @@ class TestSuite(unittest.TestCase): def test_ETS_C1P0_p0_16_j2k(self): jfile = opj_data_file('input/conformance/p0_16.j2k') jp2k = Jp2k(jfile) - jpdata = jp2k.read(rlevel=0) + jpdata = jp2k[:] pgxfile = opj_data_file('baseline/conformance/c1p0_16_0.pgx') pgxdata = read_pgx(pgxfile) @@ -186,7 +144,7 @@ class TestSuite(unittest.TestCase): def test_ETS_C1P1_p1_01_j2k(self): jfile = opj_data_file('input/conformance/p1_01.j2k') jp2k = Jp2k(jfile) - jpdata = jp2k.read(rlevel=0) + jpdata = jp2k[:] pgxfile = opj_data_file('baseline/conformance/c1p1_01_0.pgx') pgxdata = read_pgx(pgxfile) @@ -195,7 +153,7 @@ class TestSuite(unittest.TestCase): def test_ETS_C1P1_p1_02_j2k(self): jfile = opj_data_file('input/conformance/p1_02.j2k') jp2k = Jp2k(jfile) - jpdata = jp2k.read(rlevel=0) + jpdata = jp2k[:] pgxfile = opj_data_file('baseline/conformance/c1p1_02_0.pgx') pgxdata = read_pgx(pgxfile) @@ -215,33 +173,143 @@ class TestSuite(unittest.TestCase): def test_ETS_C1P1_p1_04_j2k(self): jfile = opj_data_file('input/conformance/p1_04.j2k') jp2k = Jp2k(jfile) - jpdata = jp2k.read() + jpdata = jp2k[:] pgxfile = opj_data_file('baseline/conformance/c1p1_04_0.pgx') pgxdata = read_pgx(pgxfile) self.assertTrue(peak_tolerance(jpdata, pgxdata) < 624) self.assertTrue(mse(jpdata, pgxdata) < 3080) + def test_NR_DEC_Bretagne2_j2k_1_decode(self): + jfile = opj_data_file('input/nonregression/Bretagne2.j2k') + jp2 = Jp2k(jfile) + jp2[:] + self.assertTrue(True) + + def test_NR_DEC__00042_j2k_2_decode(self): + jfile = opj_data_file('input/nonregression/_00042.j2k') + jp2 = Jp2k(jfile) + jp2[:] + self.assertTrue(True) + + def test_NR_DEC_buxI_j2k_9_decode(self): + jfile = opj_data_file('input/nonregression/buxI.j2k') + Jp2k(jfile)[:] + self.assertTrue(True) + + def test_NR_DEC_buxR_j2k_10_decode(self): + jfile = opj_data_file('input/nonregression/buxR.j2k') + Jp2k(jfile)[:] + self.assertTrue(True) + + def test_NR_DEC_Cannotreaddatawithnosizeknown_j2k_11_decode(self): + relpath = 'input/nonregression/Cannotreaddatawithnosizeknown.j2k' + jfile = opj_data_file(relpath) + Jp2k(jfile)[:] + self.assertTrue(True) + + def test_NR_DEC_cthead1_j2k_12_decode(self): + jfile = opj_data_file('input/nonregression/cthead1.j2k') + Jp2k(jfile)[:] + self.assertTrue(True) + + def test_NR_DEC_CT_Phillips_JPEG2K_Decompr_Problem_j2k_13_decode(self): + relpath = 'input/nonregression/CT_Phillips_JPEG2K_Decompr_Problem.j2k' + jfile = opj_data_file(relpath) + Jp2k(jfile)[:] + self.assertTrue(True) + + def test_NR_DEC_j2k32_j2k_15_decode(self): + jfile = opj_data_file('input/nonregression/j2k32.j2k') + Jp2k(jfile)[:] + self.assertTrue(True) + + def test_NR_DEC_MarkerIsNotCompliant_j2k_17_decode(self): + jfile = opj_data_file('input/nonregression/MarkerIsNotCompliant.j2k') + Jp2k(jfile)[:] + self.assertTrue(True) + + def test_NR_DEC_Marrin_jp2_18_decode(self): + jfile = opj_data_file('input/nonregression/Marrin.jp2') + Jp2k(jfile)[:] + self.assertTrue(True) + + def test_NR_DEC_movie_00000_j2k_20_decode(self): + jfile = opj_data_file('input/nonregression/movie_00000.j2k') + Jp2k(jfile)[:] + self.assertTrue(True) + + def test_NR_DEC_movie_00001_j2k_21_decode(self): + jfile = opj_data_file('input/nonregression/movie_00001.j2k') + Jp2k(jfile)[:] + self.assertTrue(True) + + def test_NR_DEC_movie_00002_j2k_22_decode(self): + jfile = opj_data_file('input/nonregression/movie_00002.j2k') + Jp2k(jfile)[:] + self.assertTrue(True) + + def test_NR_DEC_orb_blue_lin_j2k_j2k_23_decode(self): + jfile = opj_data_file('input/nonregression/orb-blue10-lin-j2k.j2k') + Jp2k(jfile)[:] + self.assertTrue(True) + + def test_NR_DEC_orb_blue_win_j2k_j2k_24_decode(self): + jfile = opj_data_file('input/nonregression/orb-blue10-win-j2k.j2k') + Jp2k(jfile)[:] + self.assertTrue(True) + + def test_NR_DEC_relax_jp2_27_decode(self): + jfile = opj_data_file('input/nonregression/relax.jp2') + Jp2k(jfile)[:] + self.assertTrue(True) + + def test_NR_DEC_test_lossless_j2k_28_decode(self): + jfile = opj_data_file('input/nonregression/test_lossless.j2k') + Jp2k(jfile)[:] + self.assertTrue(True) + + def test_NR_DEC_pacs_ge_j2k_30_decode(self): + jfile = opj_data_file('input/nonregression/pacs.ge.j2k') + Jp2k(jfile)[:] + self.assertTrue(True) + + +@unittest.skipIf(OPJ_DATA_ROOT is None, + "OPJ_DATA_ROOT environment variable not set") +@unittest.skipIf(WARNING_INFRASTRUCTURE_ISSUE, WARNING_INFRASTRUCTURE_MSG) +class TestSuiteWarns(MetadataBase): + """ + Identical setup to above, but these tests issue warnings. + """ + + def setUp(self): + pass + + def tearDown(self): + pass + def test_ETS_JP2_file1(self): jfile = opj_data_file('input/conformance/file1.jp2') - with warnings.catch_warnings(): + with self.assertWarns(UserWarning): # Bad compatibility list item. - warnings.simplefilter("ignore") jp2k = Jp2k(jfile) - jpdata = jp2k.read() + jpdata = jp2k[:] self.assertEqual(jpdata.shape, (512, 768, 3)) def test_ETS_JP2_file2(self): jfile = opj_data_file('input/conformance/file2.jp2') - jp2k = Jp2k(jfile) - jpdata = jp2k.read() + with self.assertWarns(UserWarning): + jp2k = Jp2k(jfile) + jpdata = jp2k[:] self.assertEqual(jpdata.shape, (640, 480, 3)) @unittest.skipIf(glymur.version.openjpeg_version_tuple[0] < 2, "Functionality not implemented for 1.x") def test_ETS_JP2_file3(self): jfile = opj_data_file('input/conformance/file3.jp2') - jp2k = Jp2k(jfile) + with self.assertWarns(UserWarning): + jp2k = Jp2k(jfile) jpdata = jp2k.read_bands() self.assertEqual(jpdata[0].shape, (640, 480)) self.assertEqual(jpdata[1].shape, (320, 240)) @@ -249,161 +317,156 @@ class TestSuite(unittest.TestCase): def test_ETS_JP2_file4(self): jfile = opj_data_file('input/conformance/file4.jp2') - jp2k = Jp2k(jfile) - jpdata = jp2k.read() + with self.assertWarns(UserWarning): + jp2k = Jp2k(jfile) + jpdata = jp2k[:] self.assertEqual(jpdata.shape, (512, 768)) def test_ETS_JP2_file5(self): jfile = opj_data_file('input/conformance/file5.jp2') - with warnings.catch_warnings(): + with self.assertWarns(UserWarning): # There's a warning for an unknown compatibility entry. # Ignore it here. - warnings.simplefilter("ignore") jp2k = Jp2k(jfile) - jpdata = jp2k.read() + jpdata = jp2k[:] self.assertEqual(jpdata.shape, (512, 768, 3)) def test_ETS_JP2_file6(self): jfile = opj_data_file('input/conformance/file6.jp2') - jp2k = Jp2k(jfile) - jpdata = jp2k.read() + with self.assertWarns(UserWarning): + jp2k = Jp2k(jfile) + jpdata = jp2k[:] self.assertEqual(jpdata.shape, (512, 768)) def test_ETS_JP2_file7(self): jfile = opj_data_file('input/conformance/file7.jp2') - jp2k = Jp2k(jfile) - jpdata = jp2k.read() + with self.assertWarns(UserWarning): + jp2k = Jp2k(jfile) + jpdata = jp2k[:] self.assertEqual(jpdata.shape, (640, 480, 3)) def test_ETS_JP2_file8(self): jfile = opj_data_file('input/conformance/file8.jp2') - jp2k = Jp2k(jfile) - jpdata = jp2k.read() + with self.assertWarns(UserWarning): + jp2k = Jp2k(jfile) + jpdata = jp2k[:] self.assertEqual(jpdata.shape, (400, 700)) def test_ETS_JP2_file9(self): jfile = opj_data_file('input/conformance/file9.jp2') - jp2k = Jp2k(jfile) - jpdata = jp2k.read() + with self.assertWarns(UserWarning): + jp2k = Jp2k(jfile) + jpdata = jp2k[:] self.assertEqual(jpdata.shape, (512, 768, 3)) - def test_NR_DEC_Bretagne2_j2k_1_decode(self): - jfile = opj_data_file('input/nonregression/Bretagne2.j2k') - jp2 = Jp2k(jfile) - jp2.read() - self.assertTrue(True) + def test_NR_broken1_jp2_dump(self): + jfile = opj_data_file('input/nonregression/broken1.jp2') - def test_NR_DEC__00042_j2k_2_decode(self): - jfile = opj_data_file('input/nonregression/_00042.j2k') - jp2 = Jp2k(jfile) - jp2.read() - self.assertTrue(True) + # The colr box has a ridiculously incorrect box length. + regex = re.compile(r'''b'colr'\sbox\shas\sincorrect\sbox\slength\s + \(\d+\)''', + re.VERBOSE) + with self.assertWarnsRegex(UserWarning, regex): + jp2 = Jp2k(jfile) - def test_NR_DEC_buxI_j2k_9_decode(self): - jfile = opj_data_file('input/nonregression/buxI.j2k') - Jp2k(jfile).read() - self.assertTrue(True) + ids = [box.box_id for box in jp2.box] + self.assertEqual(ids, ['jP ', 'ftyp', 'jp2h', 'jp2c']) - def test_NR_DEC_buxR_j2k_10_decode(self): - jfile = opj_data_file('input/nonregression/buxR.j2k') - Jp2k(jfile).read() - self.assertTrue(True) + ids = [box.box_id for box in jp2.box[2].box] + self.assertEqual(ids, ['ihdr', 'colr']) - def test_NR_DEC_Cannotreaddatawithnosizeknown_j2k_11_decode(self): - relpath = 'input/nonregression/Cannotreaddatawithnosizeknown.j2k' - jfile = opj_data_file(relpath) - Jp2k(jfile).read() - self.assertTrue(True) + # Signature box. Check for corruption. + self.assertEqual(jp2.box[0].signature, (13, 10, 135, 10)) + self.verify_filetype_box(jp2.box[1], FileTypeBox()) - def test_NR_DEC_cthead1_j2k_12_decode(self): - jfile = opj_data_file('input/nonregression/cthead1.j2k') - Jp2k(jfile).read() - self.assertTrue(True) + expected = ImageHeaderBox(152, 203, num_components=3) + self.verifyImageHeaderBox(jp2.box[2].box[0], expected) - def test_NR_DEC_CT_Phillips_JPEG2K_Decompr_Problem_j2k_13_decode(self): - relpath = 'input/nonregression/CT_Phillips_JPEG2K_Decompr_Problem.j2k' - jfile = opj_data_file(relpath) - Jp2k(jfile).read() - self.assertTrue(True) + expected = ColourSpecificationBox(colorspace=glymur.core.SRGB) + self.verifyColourSpecificationBox(jp2.box[2].box[1], expected) - def test_NR_DEC_j2k32_j2k_15_decode(self): - jfile = opj_data_file('input/nonregression/j2k32.j2k') - Jp2k(jfile).read() - self.assertTrue(True) + c = jp2.box[3].codestream - def test_NR_DEC_MarkerIsNotCompliant_j2k_17_decode(self): - jfile = opj_data_file('input/nonregression/MarkerIsNotCompliant.j2k') - Jp2k(jfile).read() - self.assertTrue(True) + ids = [x.marker_id for x in c.segment] + expected = ['SOC', 'SIZ', 'CME', 'COD', 'QCD', 'QCC', 'QCC'] + self.assertEqual(ids, expected) - def test_NR_DEC_Marrin_jp2_18_decode(self): - jfile = opj_data_file('input/nonregression/Marrin.jp2') - Jp2k(jfile).read() - self.assertTrue(True) + kwargs = {'rsiz': 0, 'xysiz': (203, 152), 'xyosiz': (0, 0), + 'xytsiz': (203, 152), 'xytosiz': (0, 0), + 'bitdepth': (8, 8, 8), + 'signed': (False, False, False), + 'xyrsiz': [(1, 1, 1), (1, 1, 1)]} + self.verifySizSegment(c.segment[1], + glymur.codestream.SIZsegment(**kwargs)) - def test_NR_DEC_movie_00000_j2k_20_decode(self): - jfile = opj_data_file('input/nonregression/movie_00000.j2k') - Jp2k(jfile).read() - self.assertTrue(True) + pargs = (glymur.core.RCME_ISO_8859_1, + "Creator: JasPer Version 1.701.0".encode()) + self.verifyCMEsegment(c.segment[2], + glymur.codestream.CMEsegment(*pargs)) - def test_NR_DEC_movie_00001_j2k_21_decode(self): - jfile = opj_data_file('input/nonregression/movie_00001.j2k') - Jp2k(jfile).read() - self.assertTrue(True) + # COD: Coding style default + self.assertFalse(c.segment[3].scod & 2) # no sop + self.assertFalse(c.segment[3].scod & 4) # no eph + self.assertEqual(c.segment[3].spcod[0], glymur.core.LRCP) + self.assertEqual(c.segment[3].layers, 1) # layers = 1 + self.assertEqual(c.segment[3].spcod[3], 1) # mct + self.assertEqual(c.segment[3].spcod[4], 5) # level + self.assertEqual(tuple(c.segment[3].code_block_size), + (64, 64)) # cblk + self.verify_codeblock_style(c.segment[3].spcod[7], + [False, False, False, False, False, False]) + self.assertEqual(c.segment[3].spcod[8], + glymur.core.WAVELET_XFORM_5X3_REVERSIBLE) + self.assertEqual(len(c.segment[3].spcod), 9) - def test_NR_DEC_movie_00002_j2k_22_decode(self): - jfile = opj_data_file('input/nonregression/movie_00002.j2k') - Jp2k(jfile).read() - self.assertTrue(True) + # QCD: Quantization default + self.assertEqual(c.segment[4].sqcd & 0x1f, 0) + self.assertEqual(c.segment[4].guard_bits, 2) + self.assertEqual(c.segment[4].mantissa, [0] * 16) + self.assertEqual(c.segment[4].exponent, + [8] + [9, 9, 10] * 5) - def test_NR_DEC_orb_blue_lin_j2k_j2k_23_decode(self): - jfile = opj_data_file('input/nonregression/orb-blue10-lin-j2k.j2k') - Jp2k(jfile).read() - self.assertTrue(True) + # QCC: Quantization component + # associated component + self.assertEqual(c.segment[5].cqcc, 1) + self.assertEqual(c.segment[5].guard_bits, 2) + # quantization type + self.assertEqual(c.segment[5].sqcc & 0x1f, 0) # none + self.assertEqual(c.segment[5].mantissa, [0] * 16) + self.assertEqual(c.segment[5].exponent, + [8] + [9, 9, 10] * 5) - def test_NR_DEC_orb_blue_win_j2k_j2k_24_decode(self): - jfile = opj_data_file('input/nonregression/orb-blue10-win-j2k.j2k') - Jp2k(jfile).read() - self.assertTrue(True) + # QCC: Quantization component + # associated component + self.assertEqual(c.segment[6].cqcc, 2) + self.assertEqual(c.segment[6].guard_bits, 2) + # quantization type + self.assertEqual(c.segment[6].sqcc & 0x1f, 0) # none + self.assertEqual(c.segment[6].mantissa, [0] * 16) + self.assertEqual(c.segment[6].exponent, + [8] + [9, 9, 10] * 5) def test_NR_DEC_orb_blue_lin_jp2_25_decode(self): jfile = opj_data_file('input/nonregression/orb-blue10-lin-jp2.jp2') - with warnings.catch_warnings(): + with self.assertWarns(UserWarning): # This file has an invalid ICC profile - warnings.simplefilter("ignore") - Jp2k(jfile).read() + Jp2k(jfile)[:] self.assertTrue(True) def test_NR_DEC_orb_blue_win_jp2_26_decode(self): jfile = opj_data_file('input/nonregression/orb-blue10-win-jp2.jp2') - Jp2k(jfile).read() - self.assertTrue(True) - - def test_NR_DEC_relax_jp2_27_decode(self): - jfile = opj_data_file('input/nonregression/relax.jp2') - Jp2k(jfile).read() - self.assertTrue(True) - - def test_NR_DEC_test_lossless_j2k_28_decode(self): - jfile = opj_data_file('input/nonregression/test_lossless.j2k') - Jp2k(jfile).read() - self.assertTrue(True) - - def test_NR_DEC_pacs_ge_j2k_30_decode(self): - jfile = opj_data_file('input/nonregression/pacs.ge.j2k') - Jp2k(jfile).read() + with self.assertWarns(UserWarning): + Jp2k(jfile)[:] self.assertTrue(True) @unittest.skipIf(OPJ_DATA_ROOT is None, "OPJ_DATA_ROOT environment variable not set") -@unittest.skipIf(glymur.version.openjpeg_version_tuple[0] == 1, +@unittest.skipIf(glymur.version.openjpeg_version_tuple[0] != 2, "Feature not supported in glymur until openjpeg 2.0") -class TestSuite_bands(unittest.TestCase): - """Runs tests introduced in version 1.x but only pass in glymur with 2.0 - - The deal here is that the feature works with 1.x, but glymur only supports - it with version 2.0. +class TestSuiteBands(unittest.TestCase): + """ + Test the read_bands method. """ def setUp(self): @@ -494,7 +557,7 @@ class TestSuite_bands(unittest.TestCase): @unittest.skipIf(OPJ_DATA_ROOT is None, "OPJ_DATA_ROOT environment variable not set") -@unittest.skipIf(glymur.version.openjpeg_version_tuple[0] == 1, +@unittest.skipIf(glymur.version.openjpeg_version_tuple[0] < 2, "Tests not passing until 2.0") class TestSuite2point0(unittest.TestCase): """Runs tests introduced in version 2.0 or that pass only in 2.0""" @@ -508,7 +571,7 @@ class TestSuite2point0(unittest.TestCase): def test_ETS_C1P0_p0_10_j2k(self): jfile = opj_data_file('input/conformance/p0_10.j2k') jp2k = Jp2k(jfile) - jpdata = jp2k.read(rlevel=0) + jpdata = jp2k[:] pgxfile = opj_data_file('baseline/conformance/c1p0_10_0.pgx') pgxdata = read_pgx(pgxfile) @@ -522,39 +585,375 @@ class TestSuite2point0(unittest.TestCase): pgxdata = read_pgx(pgxfile) np.testing.assert_array_equal(jpdata[:, :, 2], pgxdata) + @unittest.skipIf(WARNING_INFRASTRUCTURE_ISSUE, WARNING_INFRASTRUCTURE_MSG) def test_NR_DEC_broken2_jp2_5_decode(self): - # Null pointer access + """ + Invalid marker ID on codestream, Null pointer access upon read. + """ jfile = opj_data_file('input/nonregression/broken2.jp2') + regex = re.compile(r'''Invalid\smarker\sid\sencountered\sat\sbyte\s + \d+\sin\scodestream:\s*"0x[a-fA-F0-9]{4}"''', + re.VERBOSE) with self.assertRaises(IOError): - with warnings.catch_warnings(): - # Invalid marker ID. - warnings.simplefilter("ignore") - Jp2k(jfile).read() - self.assertTrue(True) + with self.assertWarnsRegex(UserWarning, regex): + Jp2k(jfile)[:] + @unittest.skipIf(WARNING_INFRASTRUCTURE_ISSUE, WARNING_INFRASTRUCTURE_MSG) def test_NR_DEC_broken4_jp2_7_decode(self): jfile = opj_data_file('input/nonregression/broken4.jp2') with self.assertRaises(IOError): - with warnings.catch_warnings(): + with self.assertWarns(UserWarning): # invalid number of subbands, bad marker ID - warnings.simplefilter("ignore") - Jp2k(jfile).read() + Jp2k(jfile)[:] self.assertTrue(True) + @unittest.skipIf(WARNING_INFRASTRUCTURE_ISSUE, WARNING_INFRASTRUCTURE_MSG) def test_NR_DEC_kakadu_v4_4_openjpegv2_broken_j2k_16_decode(self): # This test actually passes in 1.5, but produces unpleasant warning # messages that cannot be turned off? relpath = 'input/nonregression/kakadu_v4-4_openjpegv2_broken.j2k' jfile = opj_data_file(relpath) if glymur.version.openjpeg_version_tuple[0] < 2: - with warnings.catch_warnings(): + with self.assertWarns(UserWarning): # Incorrect warning issued about tile parts. - warnings.simplefilter("ignore") - Jp2k(jfile).read() + Jp2k(jfile)[:] else: - Jp2k(jfile).read() + Jp2k(jfile)[:] self.assertTrue(True) -if __name__ == "__main__": - unittest.main() +@unittest.skipIf(OPJ_DATA_ROOT is None, + "OPJ_DATA_ROOT environment variable not set") +@unittest.skipIf(re.match(r'''0|1|2.0.0''', + glymur.version.openjpeg_version) is not None, + "Only supported in 2.0.1 or higher") +class TestSuite2point1(unittest.TestCase): + """Runs tests introduced in version 2.0+ or that pass only in 2.0+""" + + def setUp(self): + pass + + def tearDown(self): + pass + + @unittest.skipIf(WARNING_INFRASTRUCTURE_ISSUE, WARNING_INFRASTRUCTURE_MSG) + def test_NR_DEC_text_GBR_jp2_29_decode(self): + jfile = opj_data_file('input/nonregression/text_GBR.jp2') + with self.assertWarns(UserWarning): + # brand is 'jp2 ', but has any icc profile. + jp2 = Jp2k(jfile) + jp2[:] + self.assertTrue(True) + + def test_NR_DEC_kodak_2layers_lrcp_j2c_31_decode(self): + jfile = opj_data_file('input/nonregression/kodak_2layers_lrcp.j2c') + Jp2k(jfile)[:] + self.assertTrue(True) + + def test_NR_DEC_kodak_2layers_lrcp_j2c_32_decode(self): + jfile = opj_data_file('input/nonregression/kodak_2layers_lrcp.j2c') + Jp2k(jfile)[::4, ::4] + self.assertTrue(True) + + def test_NR_DEC_issue104_jpxstream_jp2_33_decode(self): + jfile = opj_data_file('input/nonregression/issue104_jpxstream.jp2') + Jp2k(jfile)[:] + self.assertTrue(True) + + def test_NR_DEC_mem_b2b86b74_2753_jp2_35_decode(self): + jfile = opj_data_file('input/nonregression/mem-b2b86b74-2753.jp2') + Jp2k(jfile)[:] + self.assertTrue(True) + + @unittest.skipIf(WARNING_INFRASTRUCTURE_ISSUE, WARNING_INFRASTRUCTURE_MSG) + def test_NR_DEC_gdal_fuzzer_unchecked_num_resolutions_jp2_36_decode(self): + f = 'input/nonregression/gdal_fuzzer_unchecked_numresolutions.jp2' + jfile = opj_data_file(f) + with self.assertWarns(UserWarning): + # Invalid number of resolutions. + j = Jp2k(jfile) + with self.assertRaises(IOError): + j[:] + + @unittest.skipIf(WARNING_INFRASTRUCTURE_ISSUE, WARNING_INFRASTRUCTURE_MSG) + def test_NR_DEC_gdal_fuzzer_check_number_of_tiles_jp2_38_decode(self): + relpath = 'input/nonregression/gdal_fuzzer_check_number_of_tiles.jp2' + jfile = opj_data_file(relpath) + with self.assertWarns(UserWarning): + # Invalid number of tiles. + j = Jp2k(jfile) + with self.assertRaises(IOError): + j[:] + + @unittest.skipIf(WARNING_INFRASTRUCTURE_ISSUE, WARNING_INFRASTRUCTURE_MSG) + def test_NR_DEC_gdal_fuzzer_check_comp_dx_dy_jp2_39_decode(self): + relpath = 'input/nonregression/gdal_fuzzer_check_comp_dx_dy.jp2' + jfile = opj_data_file(relpath) + with self.assertWarns(UserWarning): + # Invalid subsampling value + with self.assertRaises(IOError): + Jp2k(jfile)[:] + + def test_NR_DEC_file_409752_jp2_40_decode(self): + jfile = opj_data_file('input/nonregression/file409752.jp2') + with self.assertRaises(RuntimeError): + Jp2k(jfile)[:] + + def test_NR_DEC_issue206_image_000_jp2_42_decode(self): + jfile = opj_data_file('input/nonregression/issue206_image-000.jp2') + Jp2k(jfile)[:] + self.assertTrue(True) + + def test_NR_DEC_p1_04_j2k_57_decode(self): + jfile = opj_data_file('input/conformance/p1_04.j2k') + jp2k = Jp2k(jfile) + tdata = jp2k[896:1024, 896:1024] # last tile + odata = jp2k[:] + np.testing.assert_array_equal(tdata, odata[896:1024, 896:1024]) + + @unittest.skipIf(WARNING_INFRASTRUCTURE_ISSUE, WARNING_INFRASTRUCTURE_MSG) + def test_NR_DEC_p1_04_j2k_57_decode_0p7_backwards_compatibility(self): + """ + 0.7.x usage deprecated + """ + jfile = opj_data_file('input/conformance/p1_04.j2k') + jp2k = Jp2k(jfile) + if sys.hexversion < 0x03000000: + with warnings.catch_warnings(): + # Suppress a warning due to deprecated syntax + warnings.simplefilter("ignore") + tdata = jp2k.read(tile=63) # last tile + else: + with self.assertWarns(DeprecationWarning): + tdata = jp2k.read(tile=63) # last tile + odata = jp2k[:] + np.testing.assert_array_equal(tdata, odata[896:1024, 896:1024]) + + @unittest.skipIf(WARNING_INFRASTRUCTURE_ISSUE, WARNING_INFRASTRUCTURE_MSG) + def test_NR_DEC_p1_04_j2k_58_decode_0p7_backwards_compatibility(self): + """ + 0.7.x usage deprecated + """ + jfile = opj_data_file('input/conformance/p1_04.j2k') + jp2k = Jp2k(jfile) + if sys.hexversion < 0x03000000: + with warnings.catch_warnings(): + # Suppress a warning due to deprecated syntax + tdata = jp2k.read(tile=63, rlevel=2) # last tile + else: + with self.assertWarns(DeprecationWarning): + tdata = jp2k.read(tile=63, rlevel=2) # last tile + odata = jp2k[::4, ::4] + np.testing.assert_array_equal(tdata, odata[224:256, 224:256]) + + def test_NR_DEC_p1_04_j2k_58_decode(self): + jfile = opj_data_file('input/conformance/p1_04.j2k') + jp2k = Jp2k(jfile) + tdata = jp2k[896:1024:4, 896:1024:4] # last tile + odata = jp2k[::4, ::4] + np.testing.assert_array_equal(tdata, odata[224:256, 224:256]) + + def test_NR_DEC_p1_04_j2k_59_decode(self): + jfile = opj_data_file('input/conformance/p1_04.j2k') + jp2k = Jp2k(jfile) + tdata = jp2k[128:256, 512:640] # 2nd row, 5th column + odata = jp2k[:] + np.testing.assert_array_equal(tdata, odata[128:256, 512:640]) + + def test_NR_DEC_p1_04_j2k_60_decode(self): + jfile = opj_data_file('input/conformance/p1_04.j2k') + jp2k = Jp2k(jfile) + tdata = jp2k[128:256:2, 512:640:2] # 2nd row, 5th column + odata = jp2k[::2, ::2] + np.testing.assert_array_equal(tdata, odata[64:128, 256:320]) + + @unittest.skipIf(WARNING_INFRASTRUCTURE_ISSUE, WARNING_INFRASTRUCTURE_MSG) + def test_NR_DEC_jp2_36_decode(self): + lst = ('input', + 'nonregression', + 'gdal_fuzzer_assert_in_opj_j2k_read_SQcd_SQcc.patch.jp2') + jfile = opj_data_file('/'.join(lst)) + with self.assertWarns(UserWarning): + # Invalid component number. + j = Jp2k(jfile) + with self.assertRaises(IOError): + j[:] + + +@unittest.skipIf(OPJ_DATA_ROOT is None, + "OPJ_DATA_ROOT environment variable not set") +@unittest.skipIf(re.match(r'''0|1|2.0.0''', + glymur.version.openjpeg_version) is not None, + "Only supported in 2.0.1 or higher") +class TestReadArea(unittest.TestCase): + """ + Runs tests introduced in version 2.0+ or that pass only in 2.0+ + + Specifically for read method with area parameter. + """ + @classmethod + def setUpClass(self): + + jfile = opj_data_file('input/conformance/p1_04.j2k') + self.j2k = Jp2k(jfile) + self.j2k_data = self.j2k[:] + self.j2k_half_data = self.j2k[::2, ::2] + self.j2k_quarter_data = self.j2k[::4, ::4] + + jfile = opj_data_file('input/conformance/p1_06.j2k') + self.j2k_p1_06 = Jp2k(jfile) + + def test_NR_DEC_p1_04_j2k_43_decode(self): + actual = self.j2k[:1024, :1024] + expected = self.j2k_data + np.testing.assert_array_equal(actual, expected) + + def test_NR_DEC_p1_04_j2k_44_decode(self): + actual = self.j2k[640:768, 512:640] + expected = self.j2k_data[640:768, 512:640] + np.testing.assert_array_equal(actual, expected) + + def test_NR_DEC_p1_04_j2k_45_decode(self): + actual = self.j2k[896:1024, 896:1024] + expected = self.j2k_data[896:1024, 896:1024] + np.testing.assert_array_equal(actual, expected) + + def test_NR_DEC_p1_04_j2k_46_decode(self): + actual = self.j2k[500:800, 100:300] + expected = self.j2k_data[500:800, 100:300] + np.testing.assert_array_equal(actual, expected) + + def test_NR_DEC_p1_04_j2k_47_decode(self): + actual = self.j2k[520:600, 260:360] + expected = self.j2k_data[520:600, 260:360] + np.testing.assert_array_equal(actual, expected) + + def test_NR_DEC_p1_04_j2k_48_decode(self): + actual = self.j2k[520:660, 260:360] + expected = self.j2k_data[520:660, 260:360] + np.testing.assert_array_equal(actual, expected) + + def test_NR_DEC_p1_04_j2k_49_decode(self): + actual = self.j2k[520:600, 360:400] + expected = self.j2k_data[520:600, 360:400] + np.testing.assert_array_equal(actual, expected) + + def test_NR_DEC_p1_04_j2k_50_decode(self): + actual = self.j2k[:1024:4, :1024:4] + expected = self.j2k_quarter_data + np.testing.assert_array_equal(actual, expected) + + def test_NR_DEC_p1_04_j2k_51_decode(self): + actual = self.j2k[640:768:4, 512:640:4] + expected = self.j2k_quarter_data[160:192, 128:160] + np.testing.assert_array_equal(actual, expected) + + def test_NR_DEC_p1_04_j2k_52_decode(self): + actual = self.j2k[896:1024:4, 896:1024:4] + expected = self.j2k_quarter_data[224:352, 224:352] + np.testing.assert_array_equal(actual, expected) + + def test_NR_DEC_p1_04_j2k_53_decode(self): + actual = self.j2k[500:800:4, 100:300:4] + expected = self.j2k_quarter_data[125:200, 25:75] + np.testing.assert_array_equal(actual, expected) + + def test_NR_DEC_p1_04_j2k_54_decode(self): + actual = self.j2k[520:600:4, 260:360:4] + expected = self.j2k_quarter_data[130:150, 65:90] + np.testing.assert_array_equal(actual, expected) + + def test_NR_DEC_p1_04_j2k_55_decode(self): + actual = self.j2k[520:660:4, 260:360:4] + expected = self.j2k_quarter_data[130:165, 65:90] + np.testing.assert_array_equal(actual, expected) + + def test_NR_DEC_p1_04_j2k_56_decode(self): + actual = self.j2k[520:600:4, 360:400:4] + expected = self.j2k_quarter_data[130:150, 90:100] + np.testing.assert_array_equal(actual, expected) + + def test_NR_DEC_p1_06_j2k_70_decode(self): + actual = self.j2k_p1_06[9:12:2, 9:12:2] + self.assertEqual(actual.shape, (1, 1, 3)) + + def test_NR_DEC_p1_06_j2k_71_decode(self): + actual = self.j2k_p1_06[10:12:2, 4:10:2] + self.assertEqual(actual.shape, (1, 3, 3)) + + def test_NR_DEC_p1_06_j2k_72_decode(self): + ssdata = self.j2k_p1_06[3:9:2, 3:9:2] + self.assertEqual(ssdata.shape, (3, 3, 3)) + + def test_NR_DEC_p1_06_j2k_73_decode(self): + ssdata = self.j2k_p1_06[4:7:2, 4:7:2] + self.assertEqual(ssdata.shape, (2, 2, 3)) + + def test_NR_DEC_p1_06_j2k_74_decode(self): + ssdata = self.j2k_p1_06[4:5:2, 4:5:2] + self.assertEqual(ssdata.shape, (1, 1, 3)) + + def test_NR_DEC_p1_06_j2k_75_decode(self): + # Image size would be 0 x 0. + with self.assertRaises((IOError, OSError)): + self.j2k_p1_06[9:12:4, 9:12:4] + + def test_NR_DEC_p0_04_j2k_85_decode(self): + actual = self.j2k[:256, :256] + expected = self.j2k_data[:256, :256] + np.testing.assert_array_equal(actual, expected) + + def test_NR_DEC_p0_04_j2k_86_decode(self): + actual = self.j2k[:128, 128:256] + expected = self.j2k_data[:128, 128:256] + np.testing.assert_array_equal(actual, expected) + + def test_NR_DEC_p0_04_j2k_87_decode(self): + actual = self.j2k[10:200, 50:120] + expected = self.j2k_data[10:200, 50:120] + np.testing.assert_array_equal(actual, expected) + + def test_NR_DEC_p0_04_j2k_88_decode(self): + actual = self.j2k[150:210, 10:190] + expected = self.j2k_data[150:210, 10:190] + np.testing.assert_array_equal(actual, expected) + + def test_NR_DEC_p0_04_j2k_89_decode(self): + actual = self.j2k[80:150, 100:200] + expected = self.j2k_data[80:150, 100:200] + np.testing.assert_array_equal(actual, expected) + + def test_NR_DEC_p0_04_j2k_90_decode(self): + actual = self.j2k[20:50, 150:200] + expected = self.j2k_data[20:50, 150:200] + np.testing.assert_array_equal(actual, expected) + + def test_NR_DEC_p0_04_j2k_91_decode(self): + actual = self.j2k[:256:4, :256:4] + expected = self.j2k_quarter_data[0:64, 0:64] + np.testing.assert_array_equal(actual, expected) + + def test_NR_DEC_p0_04_j2k_92_decode(self): + actual = self.j2k[:128:4, 128:256:4] + expected = self.j2k_quarter_data[:32, 32:64] + np.testing.assert_array_equal(actual, expected) + + def test_NR_DEC_p0_04_j2k_93_decode(self): + actual = self.j2k[10:200:4, 50:120:4] + expected = self.j2k_quarter_data[3:50, 13:30] + np.testing.assert_array_equal(actual, expected) + + def test_NR_DEC_p0_04_j2k_94_decode(self): + actual = self.j2k[150:210:4, 10:190:4] + expected = self.j2k_quarter_data[38:53, 3:48] + np.testing.assert_array_equal(actual, expected) + + def test_NR_DEC_p0_04_j2k_95_decode(self): + actual = self.j2k[80:150:4, 100:200:4] + expected = self.j2k_quarter_data[20:38, 25:50] + np.testing.assert_array_equal(actual, expected) + + def test_NR_DEC_p0_04_j2k_96_decode(self): + actual = self.j2k[20:50:4, 150:200:4] + expected = self.j2k_quarter_data[5:13, 38:50] + np.testing.assert_array_equal(actual, expected) diff --git a/glymur/test/test_opj_suite_2p1.py b/glymur/test/test_opj_suite_2p1.py deleted file mode 100644 index ebe5bf8..0000000 --- a/glymur/test/test_opj_suite_2p1.py +++ /dev/null @@ -1,389 +0,0 @@ -""" -The tests defined here roughly correspond to what is in the OpenJPEG test -suite. -""" - -# Some test names correspond with openjpeg tests. Long names are ok in this -# case. -# pylint: disable=C0103 - -# All of these tests correspond to tests in openjpeg, so no docstring is really -# needed. -# pylint: disable=C0111 - -# This module is very long, cannot be helped. -# pylint: disable=C0302 - -# unittest fools pylint with "too many public methods" -# pylint: disable=R0904 - -# Some tests use numpy test infrastructure, which means the tests never -# reference "self", so pylint claims it should be a function. No, no, no. -# pylint: disable=R0201 - -# Many tests are pretty long and that can't be helped. -# pylint: disable=R0915 - -# asserWarns introduced in python 3.2 (python2.7/pylint issue) -# pylint: disable=E1101 - -import re -import sys -import unittest - -import warnings - -import numpy as np - -from glymur import Jp2k -import glymur - -from .fixtures import OPJ_DATA_ROOT -from .fixtures import mse, peak_tolerance, read_pgx, opj_data_file - - -@unittest.skipIf(OPJ_DATA_ROOT is None, - "OPJ_DATA_ROOT environment variable not set") -@unittest.skipIf(re.match(r'''(1|2.0.0)''', - glymur.version.openjpeg_version) is not None, - "Only supported in 2.0.1 or higher") -class TestSuite2point1(unittest.TestCase): - """Runs tests introduced in version 2.0+ or that pass only in 2.0+""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def test_NR_DEC_text_GBR_jp2_29_decode(self): - jfile = opj_data_file('input/nonregression/text_GBR.jp2') - with warnings.catch_warnings(): - # brand is 'jp2 ', but has any icc profile. - warnings.simplefilter("ignore") - jp2 = Jp2k(jfile) - jp2.read() - self.assertTrue(True) - - def test_NR_DEC_kodak_2layers_lrcp_j2c_31_decode(self): - jfile = opj_data_file('input/nonregression/kodak_2layers_lrcp.j2c') - Jp2k(jfile).read() - self.assertTrue(True) - - def test_NR_DEC_kodak_2layers_lrcp_j2c_32_decode(self): - jfile = opj_data_file('input/nonregression/kodak_2layers_lrcp.j2c') - Jp2k(jfile).read(layer=2) - self.assertTrue(True) - - def test_NR_DEC_issue104_jpxstream_jp2_33_decode(self): - jfile = opj_data_file('input/nonregression/issue104_jpxstream.jp2') - Jp2k(jfile).read() - self.assertTrue(True) - - def test_NR_DEC_mem_b2b86b74_2753_jp2_35_decode(self): - jfile = opj_data_file('input/nonregression/mem-b2b86b74-2753.jp2') - Jp2k(jfile).read() - self.assertTrue(True) - - def test_NR_DEC_gdal_fuzzer_unchecked_num_resolutions_jp2_36_decode(self): - f = 'input/nonregression/gdal_fuzzer_unchecked_numresolutions.jp2' - jfile = opj_data_file(f) - with warnings.catch_warnings(): - # Invalid number of resolutions. - warnings.simplefilter("ignore") - j = Jp2k(jfile) - with self.assertRaises(IOError): - j.read() - - def test_NR_DEC_gdal_fuzzer_check_number_of_tiles_jp2_38_decode(self): - relpath = 'input/nonregression/gdal_fuzzer_check_number_of_tiles.jp2' - jfile = opj_data_file(relpath) - with warnings.catch_warnings(): - # Invalid number of tiles. - warnings.simplefilter("ignore") - j = Jp2k(jfile) - with self.assertRaises(IOError): - j.read() - - def test_NR_DEC_gdal_fuzzer_check_comp_dx_dy_jp2_39_decode(self): - relpath = 'input/nonregression/gdal_fuzzer_check_comp_dx_dy.jp2' - jfile = opj_data_file(relpath) - with warnings.catch_warnings(): - # Invalid subsampling value - warnings.simplefilter("ignore") - with self.assertRaises(IOError): - Jp2k(jfile).read() - - def test_NR_DEC_file_409752_jp2_40_decode(self): - jfile = opj_data_file('input/nonregression/file409752.jp2') - with self.assertRaises(RuntimeError): - Jp2k(jfile).read() - - def test_NR_DEC_issue206_image_000_jp2_42_decode(self): - jfile = opj_data_file('input/nonregression/issue206_image-000.jp2') - Jp2k(jfile).read() - self.assertTrue(True) - - def test_NR_DEC_p1_04_j2k_43_decode(self): - jfile = opj_data_file('input/conformance/p1_04.j2k') - jp2k = Jp2k(jfile) - ssdata = jp2k.read(area=(0, 0, 1024, 1024)) - odata = jp2k.read() - np.testing.assert_array_equal(ssdata, odata) - - def test_NR_DEC_p1_04_j2k_44_decode(self): - jfile = opj_data_file('input/conformance/p1_04.j2k') - jp2k = Jp2k(jfile) - ssdata = jp2k.read(area=(640, 512, 768, 640)) - odata = jp2k.read() - np.testing.assert_array_equal(ssdata, odata[640:768, 512:640]) - - def test_NR_DEC_p1_04_j2k_45_decode(self): - jfile = opj_data_file('input/conformance/p1_04.j2k') - jp2k = Jp2k(jfile) - ssdata = jp2k.read(area=(896, 896, 1024, 1024)) - odata = jp2k.read() - np.testing.assert_array_equal(ssdata, odata[896:1024, 896:1024]) - - def test_NR_DEC_p1_04_j2k_46_decode(self): - jfile = opj_data_file('input/conformance/p1_04.j2k') - jp2k = Jp2k(jfile) - ssdata = jp2k.read(area=(500, 100, 800, 300)) - odata = jp2k.read() - np.testing.assert_array_equal(ssdata, odata[500:800, 100:300]) - - def test_NR_DEC_p1_04_j2k_47_decode(self): - jfile = opj_data_file('input/conformance/p1_04.j2k') - jp2k = Jp2k(jfile) - ssdata = jp2k.read(area=(520, 260, 600, 360)) - odata = jp2k.read() - np.testing.assert_array_equal(ssdata, odata[520:600, 260:360]) - - def test_NR_DEC_p1_04_j2k_48_decode(self): - jfile = opj_data_file('input/conformance/p1_04.j2k') - jp2k = Jp2k(jfile) - ssdata = jp2k.read(area=(520, 260, 660, 360)) - odata = jp2k.read() - np.testing.assert_array_equal(ssdata, odata[520:660, 260:360]) - - def test_NR_DEC_p1_04_j2k_49_decode(self): - jfile = opj_data_file('input/conformance/p1_04.j2k') - jp2k = Jp2k(jfile) - ssdata = jp2k.read(area=(520, 360, 600, 400)) - odata = jp2k.read() - np.testing.assert_array_equal(ssdata, odata[520:600, 360:400]) - - def test_NR_DEC_p1_04_j2k_50_decode(self): - jfile = opj_data_file('input/conformance/p1_04.j2k') - jp2k = Jp2k(jfile) - ssdata = jp2k.read(area=(0, 0, 1024, 1024), rlevel=2) - odata = jp2k.read(rlevel=2) - - np.testing.assert_array_equal(ssdata, odata[0:256, 0:256]) - - def test_NR_DEC_p1_04_j2k_51_decode(self): - jfile = opj_data_file('input/conformance/p1_04.j2k') - jp2k = Jp2k(jfile) - ssdata = jp2k.read(area=(640, 512, 768, 640), rlevel=2) - odata = jp2k.read(rlevel=2) - np.testing.assert_array_equal(ssdata, odata[160:192, 128:160]) - - def test_NR_DEC_p1_04_j2k_52_decode(self): - jfile = opj_data_file('input/conformance/p1_04.j2k') - jp2k = Jp2k(jfile) - ssdata = jp2k.read(area=(896, 896, 1024, 1024), rlevel=2) - odata = jp2k.read(rlevel=2) - np.testing.assert_array_equal(ssdata, odata[224:352, 224:352]) - - def test_NR_DEC_p1_04_j2k_53_decode(self): - jfile = opj_data_file('input/conformance/p1_04.j2k') - jp2k = Jp2k(jfile) - ssdata = jp2k.read(area=(500, 100, 800, 300), rlevel=2) - odata = jp2k.read(rlevel=2) - np.testing.assert_array_equal(ssdata, odata[125:200, 25:75]) - - def test_NR_DEC_p1_04_j2k_54_decode(self): - jfile = opj_data_file('input/conformance/p1_04.j2k') - jp2k = Jp2k(jfile) - ssdata = jp2k.read(area=(520, 260, 600, 360), rlevel=2) - odata = jp2k.read(rlevel=2) - np.testing.assert_array_equal(ssdata, odata[130:150, 65:90]) - - def test_NR_DEC_p1_04_j2k_55_decode(self): - jfile = opj_data_file('input/conformance/p1_04.j2k') - jp2k = Jp2k(jfile) - ssdata = jp2k.read(area=(520, 260, 660, 360), rlevel=2) - odata = jp2k.read(rlevel=2) - np.testing.assert_array_equal(ssdata, odata[130:165, 65:90]) - - def test_NR_DEC_p1_04_j2k_56_decode(self): - jfile = opj_data_file('input/conformance/p1_04.j2k') - jp2k = Jp2k(jfile) - ssdata = jp2k.read(area=(520, 360, 600, 400), rlevel=2) - odata = jp2k.read(rlevel=2) - np.testing.assert_array_equal(ssdata, odata[130:150, 90:100]) - - def test_NR_DEC_p1_04_j2k_57_decode(self): - jfile = opj_data_file('input/conformance/p1_04.j2k') - jp2k = Jp2k(jfile) - tdata = jp2k.read(tile=63) # last tile - odata = jp2k.read() - np.testing.assert_array_equal(tdata, odata[896:1024, 896:1024]) - - def test_NR_DEC_p1_04_j2k_58_decode(self): - jfile = opj_data_file('input/conformance/p1_04.j2k') - jp2k = Jp2k(jfile) - tdata = jp2k.read(tile=63, rlevel=2) # last tile - odata = jp2k.read(rlevel=2) - np.testing.assert_array_equal(tdata, odata[224:256, 224:256]) - - def test_NR_DEC_p1_04_j2k_59_decode(self): - jfile = opj_data_file('input/conformance/p1_04.j2k') - jp2k = Jp2k(jfile) - tdata = jp2k.read(tile=12) # 2nd row, 5th column - odata = jp2k.read() - np.testing.assert_array_equal(tdata, odata[128:256, 512:640]) - - def test_NR_DEC_p1_04_j2k_60_decode(self): - jfile = opj_data_file('input/conformance/p1_04.j2k') - jp2k = Jp2k(jfile) - tdata = jp2k.read(tile=12, rlevel=1) # 2nd row, 5th column - odata = jp2k.read(rlevel=1) - np.testing.assert_array_equal(tdata, odata[64:128, 256:320]) - - def test_NR_DEC_jp2_36_decode(self): - lst = ('input', - 'nonregression', - 'gdal_fuzzer_assert_in_opj_j2k_read_SQcd_SQcc.patch.jp2') - jfile = opj_data_file('/'.join(lst)) - with warnings.catch_warnings(): - # Invalid component number. - warnings.simplefilter("ignore") - j = Jp2k(jfile) - with self.assertRaises(IOError): - j.read() - - def test_NR_DEC_p1_06_j2k_70_decode(self): - jfile = opj_data_file('input/conformance/p1_06.j2k') - jp2k = Jp2k(jfile) - ssdata = jp2k.read(area=(9, 9, 12, 12), rlevel=1) - self.assertEqual(ssdata.shape, (1, 1, 3)) - - def test_NR_DEC_p1_06_j2k_71_decode(self): - jfile = opj_data_file('input/conformance/p1_06.j2k') - jp2k = Jp2k(jfile) - ssdata = jp2k.read(area=(10, 4, 12, 10), rlevel=1) - self.assertEqual(ssdata.shape, (1, 3, 3)) - - def test_NR_DEC_p1_06_j2k_72_decode(self): - jfile = opj_data_file('input/conformance/p1_06.j2k') - jp2k = Jp2k(jfile) - ssdata = jp2k.read(area=(3, 3, 9, 9), rlevel=1) - self.assertEqual(ssdata.shape, (3, 3, 3)) - - def test_NR_DEC_p1_06_j2k_73_decode(self): - jfile = opj_data_file('input/conformance/p1_06.j2k') - jp2k = Jp2k(jfile) - ssdata = jp2k.read(area=(4, 4, 7, 7), rlevel=1) - self.assertEqual(ssdata.shape, (2, 2, 3)) - - def test_NR_DEC_p1_06_j2k_74_decode(self): - jfile = opj_data_file('input/conformance/p1_06.j2k') - jp2k = Jp2k(jfile) - ssdata = jp2k.read(area=(4, 4, 5, 5), rlevel=1) - self.assertEqual(ssdata.shape, (1, 1, 3)) - - def test_NR_DEC_p1_06_j2k_75_decode(self): - # Image size would be 0 x 0. - jfile = opj_data_file('input/conformance/p1_06.j2k') - jp2k = Jp2k(jfile) - with self.assertRaises((IOError, OSError)): - jp2k.read(area=(9, 9, 12, 12), rlevel=2) - - def test_NR_DEC_p0_04_j2k_85_decode(self): - jfile = opj_data_file('input/conformance/p0_04.j2k') - jp2k = Jp2k(jfile) - ssdata = jp2k.read(area=(0, 0, 256, 256)) - fulldata = jp2k.read() - np.testing.assert_array_equal(fulldata[0:256, 0:256], ssdata) - - def test_NR_DEC_p0_04_j2k_86_decode(self): - jfile = opj_data_file('input/conformance/p0_04.j2k') - jp2k = Jp2k(jfile) - ssdata = jp2k.read(area=(0, 128, 128, 256)) - fulldata = jp2k.read() - np.testing.assert_array_equal(fulldata[0:128, 128:256], ssdata) - - def test_NR_DEC_p0_04_j2k_87_decode(self): - jfile = opj_data_file('input/conformance/p0_04.j2k') - jp2k = Jp2k(jfile) - ssdata = jp2k.read(area=(10, 50, 200, 120)) - fulldata = jp2k.read() - np.testing.assert_array_equal(fulldata[10:200, 50:120], ssdata) - - def test_NR_DEC_p0_04_j2k_88_decode(self): - jfile = opj_data_file('input/conformance/p0_04.j2k') - jp2k = Jp2k(jfile) - ssdata = jp2k.read(area=(150, 10, 210, 190)) - fulldata = jp2k.read() - np.testing.assert_array_equal(fulldata[150:210, 10:190], ssdata) - - def test_NR_DEC_p0_04_j2k_89_decode(self): - jfile = opj_data_file('input/conformance/p0_04.j2k') - jp2k = Jp2k(jfile) - ssdata = jp2k.read(area=(80, 100, 150, 200)) - fulldata = jp2k.read() - np.testing.assert_array_equal(fulldata[80:150, 100:200], ssdata) - - def test_NR_DEC_p0_04_j2k_90_decode(self): - jfile = opj_data_file('input/conformance/p0_04.j2k') - jp2k = Jp2k(jfile) - ssdata = jp2k.read(area=(20, 150, 50, 200)) - fulldata = jp2k.read() - np.testing.assert_array_equal(fulldata[20:50, 150:200], ssdata) - - def test_NR_DEC_p0_04_j2k_91_decode(self): - jfile = opj_data_file('input/conformance/p0_04.j2k') - jp2k = Jp2k(jfile) - ssdata = jp2k.read(area=(0, 0, 256, 256), rlevel=2) - fulldata = jp2k.read(rlevel=2) - np.testing.assert_array_equal(fulldata[0:64, 0:64], ssdata) - - def test_NR_DEC_p0_04_j2k_92_decode(self): - jfile = opj_data_file('input/conformance/p0_04.j2k') - jp2k = Jp2k(jfile) - ssdata = jp2k.read(area=(0, 128, 128, 256), rlevel=2) - fulldata = jp2k.read(rlevel=2) - np.testing.assert_array_equal(fulldata[0:32, 32:64], ssdata) - - def test_NR_DEC_p0_04_j2k_93_decode(self): - jfile = opj_data_file('input/conformance/p0_04.j2k') - jp2k = Jp2k(jfile) - ssdata = jp2k.read(area=(10, 50, 200, 120), rlevel=2) - fulldata = jp2k.read(rlevel=2) - np.testing.assert_array_equal(fulldata[3:50, 13:30], ssdata) - - def test_NR_DEC_p0_04_j2k_94_decode(self): - jfile = opj_data_file('input/conformance/p0_04.j2k') - jp2k = Jp2k(jfile) - ssdata = jp2k.read(area=(150, 10, 210, 190), rlevel=2) - fulldata = jp2k.read(rlevel=2) - np.testing.assert_array_equal(fulldata[38:53, 3:48], ssdata) - - def test_NR_DEC_p0_04_j2k_95_decode(self): - jfile = opj_data_file('input/conformance/p0_04.j2k') - jp2k = Jp2k(jfile) - ssdata = jp2k.read(area=(80, 100, 150, 200), rlevel=2) - fulldata = jp2k.read(rlevel=2) - np.testing.assert_array_equal(fulldata[20:38, 25:50], ssdata) - - def test_NR_DEC_p0_04_j2k_96_decode(self): - jfile = opj_data_file('input/conformance/p0_04.j2k') - jp2k = Jp2k(jfile) - ssdata = jp2k.read(area=(20, 150, 50, 200), rlevel=2) - fulldata = jp2k.read(rlevel=2) - np.testing.assert_array_equal(fulldata[5:13, 38:50], ssdata) - - -if __name__ == "__main__": - unittest.main() diff --git a/glymur/test/test_opj_suite_dump.py b/glymur/test/test_opj_suite_dump.py index e24f53f..7ac513f 100644 --- a/glymur/test/test_opj_suite_dump.py +++ b/glymur/test/test_opj_suite_dump.py @@ -2,49 +2,31 @@ The tests defined here roughly correspond to what is in the OpenJPEG test suite. """ - -# Some test names correspond with openjpeg tests. Long names are ok in this -# case. -# pylint: disable=C0103 - -# All of these tests correspond to tests in openjpeg, so no docstring is really -# needed. -# pylint: disable=C0111 - -# This module is very long, cannot be helped. -# pylint: disable=C0302 - -# unittest fools pylint with "too many public methods" -# pylint: disable=R0904 - -# Some tests use numpy test infrastructure, which means the tests never -# reference "self", so pylint claims it should be a function. No, no, no. -# pylint: disable=R0201 - -# Many tests are pretty long and that can't be helped. -# pylint: disable=R0915 - -# asserWarns introduced in python 3.2 (python2.7/pylint issue) -# pylint: disable=E1101 - import re -import sys import unittest - import warnings import numpy as np -from glymur import Jp2k import glymur +from glymur import Jp2k +from glymur.codestream import CMEsegment, SOTsegment, RGNsegment +from glymur.core import (RCME_ISO_8859_1, RCME_BINARY, SRGB, + GREYSCALE, RESTRICTED_ICC_PROFILE, + ENUMERATED_COLORSPACE) +from glymur.jp2box import FileTypeBox -from .fixtures import OPJ_DATA_ROOT -from .fixtures import mse, peak_tolerance, read_pgx, opj_data_file +from .fixtures import (MetadataBase, OPJ_DATA_ROOT, + WARNING_INFRASTRUCTURE_ISSUE, + WARNING_INFRASTRUCTURE_MSG, + opj_data_file) + +comment1 = "Creator: AV-J2K (c) 2000,2001 Algo Vision Technology" @unittest.skipIf(OPJ_DATA_ROOT is None, "OPJ_DATA_ROOT environment variable not set") -class TestSuiteDump(unittest.TestCase): +class TestSuite(MetadataBase): def setUp(self): pass @@ -62,58 +44,28 @@ class TestSuiteDump(unittest.TestCase): ids = [box.box_id for box in jp2.box[2].box] self.assertEqual(ids, ['ihdr', 'colr']) - # Signature box. Check for corruption. - self.assertEqual(jp2.box[0].signature, (13, 10, 135, 10)) + self.verifySignatureBox(jp2.box[0]) + self.verify_filetype_box(jp2.box[1], FileTypeBox()) - # File type box. - self.assertEqual(jp2.box[1].brand, 'jp2 ') - self.assertEqual(jp2.box[1].minor_version, 0) - self.assertEqual(jp2.box[1].compatibility_list[0], 'jp2 ') + ihdr = glymur.jp2box.ImageHeaderBox(243, 720, num_components=3) + self.verifyImageHeaderBox(jp2.box[2].box[0], ihdr) - # Jp2 Header - # Image header - self.assertEqual(jp2.box[2].box[0].height, 243) - self.assertEqual(jp2.box[2].box[0].width, 720) - self.assertEqual(jp2.box[2].box[0].num_components, 3) - self.assertEqual(jp2.box[2].box[0].bits_per_component, 8) - self.assertEqual(jp2.box[2].box[0].signed, False) - self.assertEqual(jp2.box[2].box[0].compression, 7) # wavelet - self.assertEqual(jp2.box[2].box[0].colorspace_unknown, False) - self.assertEqual(jp2.box[2].box[0].ip_provided, False) + colr = glymur.jp2box.ColourSpecificationBox(colorspace=glymur.core.YCC) + self.verifyColourSpecificationBox(jp2.box[2].box[1], colr) - # Jp2 Header - # Colour specification - self.assertEqual(jp2.box[2].box[1].method, - glymur.core.ENUMERATED_COLORSPACE) - self.assertEqual(jp2.box[2].box[1].precedence, 0) - self.assertEqual(jp2.box[2].box[1].approximation, 0) # JP2 - self.assertEqual(jp2.box[2].box[1].colorspace, glymur.core.YCC) - - c = jp2.box[3].main_header + c = jp2.box[3].codestream ids = [x.marker_id for x in c.segment] expected = ['SOC', 'SIZ', 'COD', 'QCD'] self.assertEqual(ids, expected) - # SIZ: Image and tile size - # Profile: - self.assertEqual(c.segment[1].rsiz, 0) - # Reference grid size - self.assertEqual(c.segment[1].xsiz, 720) - self.assertEqual(c.segment[1].ysiz, 243) - # Reference grid offset - self.assertEqual((c.segment[1].xosiz, c.segment[1].yosiz), (0, 0)) - # Tile size - self.assertEqual((c.segment[1].xtsiz, c.segment[1].ytsiz), (720, 243)) - # Tile offset - self.assertEqual((c.segment[1].xtosiz, c.segment[1].ytosiz), (0, 0)) - # bitdepth - self.assertEqual(c.segment[1].bitdepth, (8, 8, 8)) - # signed - self.assertEqual(c.segment[1].signed, (False, False, False)) - # subsampling - self.assertEqual(list(zip(c.segment[1].xrsiz, c.segment[1].yrsiz)), - [(1, 1), (2, 1), (2, 1)]) + kwargs = {'rsiz': 0, 'xysiz': (720, 243), 'xyosiz': (0, 0), + 'xytsiz': (720, 243), 'xytosiz': (0, 0), + 'bitdepth': (8, 8, 8), + 'signed': (False, False, False), + 'xyrsiz': [(1, 2, 2), (1, 1, 1)]} + self.verifySizSegment(c.segment[1], + glymur.codestream.SIZsegment(**kwargs)) # COD: Coding style default self.assertFalse(c.segment[2].scod & 2) # no sop @@ -124,18 +76,8 @@ class TestSuiteDump(unittest.TestCase): self.assertEqual(c.segment[2].spcod[4], 5) # level self.assertEqual(tuple(c.segment[2].code_block_size), (32, 128)) # cblk - # Selective arithmetic coding bypass - self.assertFalse(c.segment[2].spcod[7] & 0x01) - # Reset context probabilities - self.assertFalse(c.segment[2].spcod[7] & 0x02) - # Termination on each coding pass - self.assertFalse(c.segment[2].spcod[7] & 0x04) - # Vertically causal context - self.assertFalse(c.segment[2].spcod[7] & 0x08) - # Predictable termination - self.assertFalse(c.segment[2].spcod[7] & 0x0010) - # Segmentation symbols - self.assertFalse(c.segment[2].spcod[7] & 0x0020) + self.verify_codeblock_style(c.segment[2].spcod[7], + [False, False, False, False, False, False]) self.assertEqual(c.segment[2].spcod[8], glymur.core.WAVELET_XFORM_9X7_IRREVERSIBLE) self.assertEqual(len(c.segment[2].spcod), 9) @@ -158,25 +100,11 @@ class TestSuiteDump(unittest.TestCase): expected = ['SOC', 'SIZ', 'QCD', 'COD', 'SOT', 'SOD', 'EOC'] self.assertEqual(actual, expected) - # SIZ: Image and tile size - # Profile: "1" means profile 0 - self.assertEqual(c.segment[1].rsiz, 1) - # Reference grid size - self.assertEqual(c.segment[1].xsiz, 128) - self.assertEqual(c.segment[1].ysiz, 128) - # Reference grid offset - self.assertEqual((c.segment[1].xosiz, c.segment[1].yosiz), (0, 0)) - # Tile size - self.assertEqual((c.segment[1].xtsiz, c.segment[1].ytsiz), (128, 128)) - # Tile offset - self.assertEqual((c.segment[1].xtosiz, c.segment[1].ytosiz), (0, 0)) - # bitdepth - self.assertEqual(c.segment[1].bitdepth, (8,)) - # signed - self.assertEqual(c.segment[1].signed, (False,)) - # subsampling - self.assertEqual(list(zip(c.segment[1].xrsiz, c.segment[1].yrsiz)), - [(1, 1)]) + kwargs = {'rsiz': 1, 'xysiz': (128, 128), 'xyosiz': (0, 0), + 'xytsiz': (128, 128), 'xytosiz': (0, 0), 'bitdepth': (8,), + 'signed': (False,), 'xyrsiz': [(1,), (1,)]} + self.verifySizSegment(c.segment[1], + glymur.codestream.SIZsegment(**kwargs)) # QCD: Quantization default self.assertEqual(c.segment[2].sqcd & 0x1f, 0) @@ -195,50 +123,22 @@ class TestSuiteDump(unittest.TestCase): self.assertEqual(c.segment[3].spcod[4], 3) # layers self.assertEqual(tuple(c.segment[3].code_block_size), (64, 64)) # cblk - # Selective arithmetic coding bypass - self.assertFalse(c.segment[3].spcod[7] & 0x01) - # Reset context probabilities - self.assertFalse(c.segment[3].spcod[7] & 0x02) - # Termination on each coding pass - self.assertFalse(c.segment[3].spcod[7] & 0x04) - # Vertically causal context - self.assertFalse(c.segment[3].spcod[7] & 0x08) - # Predictable termination - self.assertFalse(c.segment[3].spcod[7] & 0x0010) - # Segmentation symbols - self.assertFalse(c.segment[3].spcod[7] & 0x0020) + self.verify_codeblock_style(c.segment[3].spcod[7], + [False, False, False, False, False, False]) self.assertEqual(c.segment[3].spcod[8], glymur.core.WAVELET_XFORM_5X3_REVERSIBLE) - # SOT: start of tile part - self.assertEqual(c.segment[4].isot, 0) - self.assertEqual(c.segment[4].psot, 7314) - self.assertEqual(c.segment[4].tpsot, 0) - self.assertEqual(c.segment[4].tnsot, 1) + self.verifySOTsegment(c.segment[4], SOTsegment(0, 7314, 0, 1)) def test_NR_p0_02_dump(self): jfile = opj_data_file('input/conformance/p0_02.j2k') c = Jp2k(jfile).get_codestream(header_only=False) - # SIZ: Image and tile size - # Profile: "1" means profile 0 - self.assertEqual(c.segment[1].rsiz, 1) - # Reference grid size - self.assertEqual(c.segment[1].xsiz, 127) - self.assertEqual(c.segment[1].ysiz, 126) - # Reference grid offset - self.assertEqual((c.segment[1].xosiz, c.segment[1].yosiz), (0, 0)) - # Tile size - self.assertEqual((c.segment[1].xtsiz, c.segment[1].ytsiz), (127, 126)) - # Tile offset - self.assertEqual((c.segment[1].xtosiz, c.segment[1].ytosiz), (0, 0)) - # bitdepth - self.assertEqual(c.segment[1].bitdepth, (8,)) - # signed - self.assertEqual(c.segment[1].signed, (False,)) - # subsampling - self.assertEqual(list(zip(c.segment[1].xrsiz, c.segment[1].yrsiz)), - [(2, 1)]) + kwargs = {'rsiz': 1, 'xysiz': (127, 126), 'xyosiz': (0, 0), + 'xytsiz': (127, 126), 'xytosiz': (0, 0), 'bitdepth': (8,), + 'signed': (False,), 'xyrsiz': [(2,), (1,)]} + self.verifySizSegment(c.segment[1], + glymur.codestream.SIZsegment(**kwargs)) # COD: Coding style default self.assertTrue(c.segment[2].scod & 2) # sop @@ -249,18 +149,8 @@ class TestSuiteDump(unittest.TestCase): self.assertEqual(c.segment[2].spcod[4], 3) # levels self.assertEqual(tuple(c.segment[2].code_block_size), (64, 64)) # cblk - # Selective arithmetic coding bypass - self.assertFalse(c.segment[2].spcod[7] & 0x01) - # Reset context probabilities - self.assertFalse(c.segment[2].spcod[7] & 0x02) - # Termination on each coding pass - self.assertTrue(c.segment[2].spcod[7] & 0x04) - # Vertically causal context - self.assertFalse(c.segment[2].spcod[7] & 0x08) - # Predictable termination - self.assertTrue(c.segment[2].spcod[7] & 0x0010) - # Segmentation symbols - self.assertTrue(c.segment[2].spcod[7] & 0x0020) + self.verify_codeblock_style(c.segment[2].spcod[7], + [False, False, True, False, True, True]) self.assertEqual(c.segment[2].spcod[8], glymur.core.WAVELET_XFORM_9X7_IRREVERSIBLE) @@ -269,18 +159,8 @@ class TestSuiteDump(unittest.TestCase): self.assertEqual(c.segment[3].spcoc[0], 3) # levels self.assertEqual(tuple(c.segment[3].code_block_size), (32, 32)) # cblk - # Selective arithmetic coding bypass - self.assertFalse(c.segment[3].spcoc[3] & 0x01) - # Reset context probabilities - self.assertFalse(c.segment[3].spcoc[3] & 0x02) - # Termination on each coding pass - self.assertTrue(c.segment[3].spcoc[3] & 0x04) - # Vertically causal context - self.assertFalse(c.segment[3].spcoc[3] & 0x08) - # Predictable termination - self.assertTrue(c.segment[3].spcoc[3] & 0x0010) - # Segmentation symbols - self.assertTrue(c.segment[3].spcoc[3] & 0x0020) + self.verify_codeblock_style(c.segment[3].spcoc[3], + [False, False, True, False, True, True]) self.assertEqual(c.segment[3].spcoc[4], glymur.core.WAVELET_XFORM_5X3_REVERSIBLE) @@ -293,21 +173,14 @@ class TestSuiteDump(unittest.TestCase): self.assertEqual(c.segment[4].mantissa, [0, 0, 0, 0, 0, 0, 0, 0, 0, 0]) - # COM: comment - # Registration - self.assertEqual(c.segment[5].rcme, glymur.core.RCME_ISO_8859_1) - # Comment value - self.assertEqual(c.segment[5].ccme.decode('latin-1'), - "Creator: AV-J2K (c) 2000,2001 Algo Vision") + pargs = (RCME_ISO_8859_1, + "Creator: AV-J2K (c) 2000,2001 Algo Vision".encode()) + self.verifyCMEsegment(c.segment[5], CMEsegment(*pargs)) # One unknown marker self.assertEqual(c.segment[6].marker_id, '0xff30') - # SOT: start of tile part - self.assertEqual(c.segment[7].isot, 0) - self.assertEqual(c.segment[7].psot, 6047) - self.assertEqual(c.segment[7].tpsot, 0) - self.assertEqual(c.segment[7].tnsot, 1) + self.verifySOTsegment(c.segment[7], SOTsegment(0, 6047, 0, 1)) # SOD: start of data # Just one. @@ -326,25 +199,11 @@ class TestSuiteDump(unittest.TestCase): jfile = opj_data_file('input/conformance/p0_03.j2k') c = Jp2k(jfile).get_codestream(header_only=False) - # SIZ: Image and tile size - # Profile: "1" means profile 0 - self.assertEqual(c.segment[1].rsiz, 1) - # Reference grid size - self.assertEqual(c.segment[1].xsiz, 256) - self.assertEqual(c.segment[1].ysiz, 256) - # Reference grid offset - self.assertEqual((c.segment[1].xosiz, c.segment[1].yosiz), (0, 0)) - # Tile size - self.assertEqual((c.segment[1].xtsiz, c.segment[1].ytsiz), (128, 128)) - # Tile offset - self.assertEqual((c.segment[1].xtosiz, c.segment[1].ytosiz), (0, 0)) - # bitdepth - self.assertEqual(c.segment[1].bitdepth, (4,)) - # signed - self.assertEqual(c.segment[1].signed, (True,)) - # subsampling - self.assertEqual(list(zip(c.segment[1].xrsiz, c.segment[1].yrsiz)), - [(1, 1)]) + kwargs = {'rsiz': 1, 'xysiz': (256, 256), 'xyosiz': (0, 0), + 'xytsiz': (128, 128), 'xytosiz': (0, 0), 'bitdepth': (4,), + 'signed': (True,), 'xyrsiz': [(1,), (1,)]} + self.verifySizSegment(c.segment[1], + glymur.codestream.SIZsegment(**kwargs)) # COD: Coding style default self.assertTrue(c.segment[2].scod & 2) @@ -355,18 +214,8 @@ class TestSuiteDump(unittest.TestCase): self.assertEqual(c.segment[2].spcod[4], 1) # levels self.assertEqual(tuple(c.segment[2].code_block_size), (64, 64)) # cblk - # Selective arithmetic coding bypass - self.assertFalse(c.segment[2].spcod[7] & 0x01) - # Reset context probabilities - self.assertFalse(c.segment[2].spcod[7] & 0x02) - # Termination on each coding pass - self.assertFalse(c.segment[2].spcod[7] & 0x04) - # Vertically causal context - self.assertFalse(c.segment[2].spcod[7] & 0x08) - # Predictable termination - self.assertFalse(c.segment[2].spcod[7] & 0x0010) - # Segmentation symbols - self.assertFalse(c.segment[2].spcod[7] & 0x0020) + self.verify_codeblock_style(c.segment[2].spcod[7], + [False, False, False, False, False, False]) self.assertEqual(c.segment[2].spcod[8], glymur.core.WAVELET_XFORM_5X3_REVERSIBLE) @@ -398,42 +247,23 @@ class TestSuiteDump(unittest.TestCase): self.assertEqual(c.segment[6].xcrg, (65424,)) self.assertEqual(c.segment[6].ycrg, (32558,)) - # COM: comment - # Registration - self.assertEqual(c.segment[7].rcme, glymur.core.RCME_ISO_8859_1) - # Comment value - self.assertEqual(c.segment[7].ccme.decode('latin-1'), - "Creator: AV-J2K (c) 2000,2001 Algo Vision") + pargs = (RCME_ISO_8859_1, + "Creator: AV-J2K (c) 2000,2001 Algo Vision".encode()) + self.verifyCMEsegment(c.segment[7], CMEsegment(*pargs)) - # COM: comment - # Registration - self.assertEqual(c.segment[8].rcme, glymur.core.RCME_ISO_8859_1) - # Comment value - self.assertEqual(c.segment[8].ccme.decode('latin-1'), - "Creator: AV-J2K (c) 2000," - + "2001 Algo Vision Technology") + pargs = (RCME_ISO_8859_1, comment1.encode()) + self.verifyCMEsegment(c.segment[8], CMEsegment(*pargs)) - # COM: comment - # Registration - self.assertEqual(c.segment[9].rcme, glymur.core.RCME_BINARY) - # Comment value - self.assertEqual(len(c.segment[9].ccme), 62) + pargs = (RCME_BINARY, c.segment[9].ccme) + self.verifyCMEsegment(c.segment[9], CMEsegment(*pargs)) # TLM (tile-part length) self.assertEqual(c.segment[10].ztlm, 0) self.assertEqual(c.segment[10].ttlm, (0, 1, 2, 3)) self.assertEqual(c.segment[10].ptlm, (4267, 2117, 4080, 2081)) - # SOT: start of tile part - self.assertEqual(c.segment[11].isot, 0) - self.assertEqual(c.segment[11].psot, 4267) - self.assertEqual(c.segment[11].tpsot, 0) - self.assertEqual(c.segment[11].tnsot, 1) - - # RGN: region of interest - self.assertEqual(c.segment[12].crgn, 0) - self.assertEqual(c.segment[12].srgn, 0) - self.assertEqual(c.segment[12].sprgn, 7) + self.verifySOTsegment(c.segment[11], SOTsegment(0, 4267, 0, 1)) + self.verifyRGNsegment(c.segment[12], RGNsegment(0, 0, 7)) # SOD: start of data # Just one. @@ -443,25 +273,13 @@ class TestSuiteDump(unittest.TestCase): jfile = opj_data_file('input/conformance/p0_04.j2k') c = Jp2k(jfile).get_codestream(header_only=False) - # SIZ: Image and tile size - # Profile: "1" means profile 0 - self.assertEqual(c.segment[1].rsiz, 1) - # Reference grid size - self.assertEqual(c.segment[1].xsiz, 640) - self.assertEqual(c.segment[1].ysiz, 480) - # Reference grid offset - self.assertEqual((c.segment[1].xosiz, c.segment[1].yosiz), (0, 0)) - # Tile size - self.assertEqual((c.segment[1].xtsiz, c.segment[1].ytsiz), (640, 480)) - # Tile offset - self.assertEqual((c.segment[1].xtosiz, c.segment[1].ytosiz), (0, 0)) - # bitdepth - self.assertEqual(c.segment[1].bitdepth, (8, 8, 8)) - # signed - self.assertEqual(c.segment[1].signed, (False, False, False)) - # subsampling - self.assertEqual(list(zip(c.segment[1].xrsiz, c.segment[1].yrsiz)), - [(1, 1), (1, 1), (1, 1)]) + kwargs = {'rsiz': 1, 'xysiz': (640, 480), 'xyosiz': (0, 0), + 'xytsiz': (640, 480), 'xytosiz': (0, 0), + 'bitdepth': (8, 8, 8), + 'signed': (False, False, False), + 'xyrsiz': [(1, 1, 1), (1, 1, 1)]} + self.verifySizSegment(c.segment[1], + glymur.codestream.SIZsegment(**kwargs)) # COD: Coding style default self.assertFalse(c.segment[2].scod & 2) @@ -472,18 +290,8 @@ class TestSuiteDump(unittest.TestCase): self.assertEqual(c.segment[2].spcod[4], 6) # levels self.assertEqual(tuple(c.segment[2].code_block_size), (64, 64)) # cblk - # Selective arithmetic coding bypass - self.assertFalse(c.segment[2].spcod[7] & 0x01) - # Reset context probabilities - self.assertFalse(c.segment[2].spcod[7] & 0x02) - # Termination on each coding pass - self.assertTrue(c.segment[2].spcod[7] & 0x04) - # Vertically causal context - self.assertFalse(c.segment[2].spcod[7] & 0x08) - # Predictable termination - self.assertFalse(c.segment[2].spcod[7] & 0x0010) - # Segmentation symbols - self.assertFalse(c.segment[2].spcod[7] & 0x0020) + self.verify_codeblock_style(c.segment[2].spcod[7], + [False, False, True, False, False, False]) self.assertEqual(c.segment[2].spcod[8], glymur.core.WAVELET_XFORM_9X7_IRREVERSIBLE) self.assertEqual(c.segment[2].precinct_size, @@ -530,18 +338,11 @@ class TestSuiteDump(unittest.TestCase): 1845, 1868, 1925, 1925, 2007, 32, 32, 131, 2002, 2002, 1888]) - # COM: comment - # Registration - self.assertEqual(c.segment[6].rcme, glymur.core.RCME_ISO_8859_1) - # Comment value - self.assertEqual(c.segment[6].ccme.decode('latin-1'), - "Creator: AV-J2K (c) 2000,2001 Algo Vision") + pargs = (RCME_ISO_8859_1, + "Creator: AV-J2K (c) 2000,2001 Algo Vision".encode()) + self.verifyCMEsegment(c.segment[6], CMEsegment(*pargs)) - # SOT: start of tile part - self.assertEqual(c.segment[7].isot, 0) - self.assertEqual(c.segment[7].psot, 264383) - self.assertEqual(c.segment[7].tpsot, 0) - self.assertEqual(c.segment[7].tnsot, 1) + self.verifySOTsegment(c.segment[7], SOTsegment(0, 264383, 0, 1)) # SOD: start of data # Just one. @@ -551,26 +352,13 @@ class TestSuiteDump(unittest.TestCase): jfile = opj_data_file('input/conformance/p0_05.j2k') c = Jp2k(jfile).get_codestream(header_only=False) - # SIZ: Image and tile size - # Profile: "1" means profile 0 - self.assertEqual(c.segment[1].rsiz, 1) - # Reference grid size - self.assertEqual(c.segment[1].xsiz, 1024) - self.assertEqual(c.segment[1].ysiz, 1024) - # Reference grid offset - self.assertEqual((c.segment[1].xosiz, c.segment[1].yosiz), (0, 0)) - # Tile size - self.assertEqual((c.segment[1].xtsiz, c.segment[1].ytsiz), - (1024, 1024)) - # Tile offset - self.assertEqual((c.segment[1].xtosiz, c.segment[1].ytosiz), (0, 0)) - # bitdepth - self.assertEqual(c.segment[1].bitdepth, (8, 8, 8, 8)) - # signed - self.assertEqual(c.segment[1].signed, (False, False, False, False)) - # subsampling - self.assertEqual(list(zip(c.segment[1].xrsiz, c.segment[1].yrsiz)), - [(1, 1), (1, 1), (2, 2), (2, 2)]) + kwargs = {'rsiz': 1, 'xysiz': (1024, 1024), 'xyosiz': (0, 0), + 'xytsiz': (1024, 1024), 'xytosiz': (0, 0), + 'bitdepth': (8, 8, 8, 8), + 'signed': (False, False, False, False), + 'xyrsiz': [(1, 1, 2, 2), (1, 1, 2, 2)]} + self.verifySizSegment(c.segment[1], + glymur.codestream.SIZsegment(**kwargs)) # COD: Coding style default self.assertFalse(c.segment[2].scod & 2) @@ -581,18 +369,8 @@ class TestSuiteDump(unittest.TestCase): self.assertEqual(c.segment[2].spcod[4], 6) # levels self.assertEqual(tuple(c.segment[2].code_block_size), (32, 32)) # cblk - # Selective arithmetic coding bypass - self.assertFalse(c.segment[2].spcod[7] & 0x01) - # Reset context probabilities - self.assertFalse(c.segment[2].spcod[7] & 0x02) - # Termination on each coding pass - self.assertFalse(c.segment[2].spcod[7] & 0x04) - # Vertically causal context - self.assertFalse(c.segment[2].spcod[7] & 0x08) - # Predictable termination - self.assertFalse(c.segment[2].spcod[7] & 0x0010) - # Segmentation symbols - self.assertFalse(c.segment[2].spcod[7] & 0x0020) + self.verify_codeblock_style(c.segment[2].spcod[7], + [False, False, False, False, False, False]) self.assertEqual(c.segment[2].spcod[8], glymur.core.WAVELET_XFORM_9X7_IRREVERSIBLE) self.assertEqual(len(c.segment[2].spcod), 9) @@ -602,18 +380,8 @@ class TestSuiteDump(unittest.TestCase): self.assertEqual(c.segment[3].spcoc[0], 3) # levels self.assertEqual(tuple(c.segment[3].code_block_size), (32, 32)) # cblk - # Selective arithmetic coding bypass - self.assertFalse(c.segment[3].spcoc[3] & 0x01) - # Reset context probabilities - self.assertFalse(c.segment[3].spcoc[3] & 0x02) - # Termination on each coding pass - self.assertFalse(c.segment[3].spcoc[3] & 0x04) - # Vertically causal context - self.assertFalse(c.segment[3].spcoc[3] & 0x08) - # Predictable termination - self.assertFalse(c.segment[3].spcoc[3] & 0x0010) - # Segmentation symbols - self.assertFalse(c.segment[3].spcoc[3] & 0x0020) + self.verify_codeblock_style(c.segment[3].spcoc[3], + [False, False, False, False, False, False]) self.assertEqual(c.segment[3].spcoc[4], glymur.core.WAVELET_XFORM_9X7_IRREVERSIBLE) @@ -622,18 +390,8 @@ class TestSuiteDump(unittest.TestCase): self.assertEqual(c.segment[4].spcoc[0], 6) # levels self.assertEqual(tuple(c.segment[4].code_block_size), (32, 32)) # cblk - # Selective arithmetic coding bypass - self.assertFalse(c.segment[4].spcoc[3] & 0x01) - # Reset context probabilities - self.assertFalse(c.segment[4].spcoc[3] & 0x02) - # Termination on each coding pass - self.assertFalse(c.segment[4].spcoc[3] & 0x04) - # Vertically causal context - self.assertFalse(c.segment[4].spcoc[3] & 0x08) - # Predictable termination - self.assertFalse(c.segment[4].spcoc[3] & 0x0010) - # Segmentation symbols - self.assertFalse(c.segment[4].spcoc[3] & 0x0020) + self.verify_codeblock_style(c.segment[4].spcoc[3], + [False, False, False, False, False, False]) self.assertEqual(c.segment[4].spcoc[4], glymur.core.WAVELET_XFORM_5X3_REVERSIBLE) @@ -669,23 +427,16 @@ class TestSuiteDump(unittest.TestCase): 9, 9, 10]) self.assertEqual(c.segment[7].mantissa, [0] * 19) - # COM: comment - # Registration - self.assertEqual(c.segment[8].rcme, glymur.core.RCME_ISO_8859_1) - # Comment value - self.assertEqual(c.segment[8].ccme.decode('latin-1'), - "Creator: AV-J2K (c) 2000,2001 Algo Vision") + pargs = (RCME_ISO_8859_1, + "Creator: AV-J2K (c) 2000,2001 Algo Vision".encode()) + self.verifyCMEsegment(c.segment[8], CMEsegment(*pargs)) # TLM (tile-part length) self.assertEqual(c.segment[9].ztlm, 0) self.assertEqual(c.segment[9].ttlm, (0,)) self.assertEqual(c.segment[9].ptlm, (1310540,)) - # SOT: start of tile part - self.assertEqual(c.segment[10].isot, 0) - self.assertEqual(c.segment[10].psot, 1310540) - self.assertEqual(c.segment[10].tpsot, 0) - self.assertEqual(c.segment[10].tnsot, 1) + self.verifySOTsegment(c.segment[10], SOTsegment(0, 1310540, 0, 1)) # SOD: start of data # Just one. @@ -695,25 +446,13 @@ class TestSuiteDump(unittest.TestCase): jfile = opj_data_file('input/conformance/p0_06.j2k') c = Jp2k(jfile).get_codestream(header_only=False) - # SIZ: Image and tile size - # Profile: "1" means profile 0 - self.assertEqual(c.segment[1].rsiz, 2) - # Reference grid size - self.assertEqual(c.segment[1].xsiz, 513) - self.assertEqual(c.segment[1].ysiz, 129) - # Reference grid offset - self.assertEqual((c.segment[1].xosiz, c.segment[1].yosiz), (0, 0)) - # Tile size - self.assertEqual((c.segment[1].xtsiz, c.segment[1].ytsiz), (513, 129)) - # Tile offset - self.assertEqual((c.segment[1].xtosiz, c.segment[1].ytosiz), (0, 0)) - # bitdepth - self.assertEqual(c.segment[1].bitdepth, (12, 12, 12, 12)) - # signed - self.assertEqual(c.segment[1].signed, (False, False, False, False)) - # subsampling - self.assertEqual(list(zip(c.segment[1].xrsiz, c.segment[1].yrsiz)), - [(1, 1), (2, 1), (1, 2), (2, 2)]) + kwargs = {'rsiz': 2, 'xysiz': (513, 129), 'xyosiz': (0, 0), + 'xytsiz': (513, 129), 'xytosiz': (0, 0), + 'bitdepth': (12, 12, 12, 12), + 'signed': (False, False, False, False), + 'xyrsiz': [(1, 2, 1, 2), (1, 1, 2, 2)]} + self.verifySizSegment(c.segment[1], + glymur.codestream.SIZsegment(**kwargs)) # COD: Coding style default self.assertFalse(c.segment[2].scod & 2) @@ -724,18 +463,8 @@ class TestSuiteDump(unittest.TestCase): self.assertEqual(c.segment[2].spcod[4], 6) # levels self.assertEqual(tuple(c.segment[2].code_block_size), (64, 64)) # cblk - # Selective arithmetic coding bypass - self.assertFalse(c.segment[2].spcod[7] & 0x01) - # Reset context probabilities - self.assertFalse(c.segment[2].spcod[7] & 0x02) - # Termination on each coding pass - self.assertFalse(c.segment[2].spcod[7] & 0x04) - # Vertically causal context - self.assertFalse(c.segment[2].spcod[7] & 0x08) - # Predictable termination - self.assertFalse(c.segment[2].spcod[7] & 0x0010) - # Segmentation symbols - self.assertFalse(c.segment[2].spcod[7] & 0x0020) + self.verify_codeblock_style(c.segment[2].spcod[7], + [False, False, False, False, False, False]) self.assertEqual(c.segment[2].spcod[8], glymur.core.WAVELET_XFORM_9X7_IRREVERSIBLE) self.assertEqual(len(c.segment[2].spcod), 9) @@ -793,36 +522,14 @@ class TestSuiteDump(unittest.TestCase): self.assertEqual(c.segment[7].spcoc[0], 6) # levels self.assertEqual(tuple(c.segment[7].code_block_size), (64, 64)) # cblk - # Selective arithmetic coding bypass - self.assertFalse(c.segment[7].spcoc[3] & 0x01) - # Reset context probabilities - self.assertFalse(c.segment[7].spcoc[3] & 0x02) - # Termination on each coding pass - self.assertFalse(c.segment[7].spcoc[3] & 0x04) - # Vertically causal context - self.assertFalse(c.segment[7].spcoc[3] & 0x08) - # Predictable termination - self.assertFalse(c.segment[7].spcoc[3] & 0x0010) - # Segmentation symbols - self.assertFalse(c.segment[7].spcoc[3] & 0x0020) + self.verify_codeblock_style(c.segment[7].spcoc[3], + [False, False, False, False, False, False]) self.assertEqual(c.segment[7].spcoc[4], glymur.core.WAVELET_XFORM_5X3_REVERSIBLE) - # RGN: region of interest - self.assertEqual(c.segment[8].crgn, 0) # component - self.assertEqual(c.segment[8].srgn, 0) # implicit - self.assertEqual(c.segment[8].sprgn, 11) - - # SOT: start of tile part - self.assertEqual(c.segment[9].isot, 0) - self.assertEqual(c.segment[9].psot, 33582) - self.assertEqual(c.segment[9].tpsot, 0) - self.assertEqual(c.segment[9].tnsot, 1) - - # RGN: region of interest - self.assertEqual(c.segment[10].crgn, 0) # component - self.assertEqual(c.segment[10].srgn, 0) # implicit - self.assertEqual(c.segment[10].sprgn, 9) + self.verifyRGNsegment(c.segment[8], RGNsegment(0, 0, 11)) + self.verifySOTsegment(c.segment[9], SOTsegment(0, 33582, 0, 1)) + self.verifyRGNsegment(c.segment[10], RGNsegment(0, 0, 9)) # SOD: start of data # Just one. @@ -832,25 +539,13 @@ class TestSuiteDump(unittest.TestCase): jfile = opj_data_file('input/conformance/p0_07.j2k') c = Jp2k(jfile).get_codestream(header_only=False) - # SIZ: Image and tile size - # Profile: "1" means profile 0 - self.assertEqual(c.segment[1].rsiz, 1) - # Reference grid size - self.assertEqual(c.segment[1].xsiz, 2048) - self.assertEqual(c.segment[1].ysiz, 2048) - # Reference grid offset - self.assertEqual((c.segment[1].xosiz, c.segment[1].yosiz), (0, 0)) - # Tile size - self.assertEqual((c.segment[1].xtsiz, c.segment[1].ytsiz), (128, 128)) - # Tile offset - self.assertEqual((c.segment[1].xtosiz, c.segment[1].ytosiz), (0, 0)) - # bitdepth - self.assertEqual(c.segment[1].bitdepth, (12, 12, 12)) - # signed - self.assertEqual(c.segment[1].signed, (True, True, True)) - # subsampling - self.assertEqual(list(zip(c.segment[1].xrsiz, c.segment[1].yrsiz)), - [(1, 1), (1, 1), (1, 1)]) + kwargs = {'rsiz': 1, 'xysiz': (2048, 2048), 'xyosiz': (0, 0), + 'xytsiz': (128, 128), 'xytosiz': (0, 0), + 'bitdepth': (12, 12, 12), + 'signed': (True, True, True), + 'xyrsiz': [(1, 1, 1), (1, 1, 1)]} + self.verifySizSegment(c.segment[1], + glymur.codestream.SIZsegment(**kwargs)) # COD: Coding style default self.assertTrue(c.segment[2].scod & 2) @@ -861,18 +556,8 @@ class TestSuiteDump(unittest.TestCase): self.assertEqual(c.segment[2].spcod[4], 3) # levels self.assertEqual(tuple(c.segment[2].code_block_size), (64, 64)) # cblk - # Selective arithmetic coding bypass - self.assertFalse(c.segment[2].spcod[7] & 0x01) - # Reset context probabilities - self.assertFalse(c.segment[2].spcod[7] & 0x02) - # Termination on each coding pass - self.assertFalse(c.segment[2].spcod[7] & 0x04) - # Vertically causal context - self.assertFalse(c.segment[2].spcod[7] & 0x08) - # Predictable termination - self.assertFalse(c.segment[2].spcod[7] & 0x0010) - # Segmentation symbols - self.assertFalse(c.segment[2].spcod[7] & 0x0020) + self.verify_codeblock_style(c.segment[2].spcod[7], + [False, False, False, False, False, False]) self.assertEqual(c.segment[2].spcod[8], glymur.core.WAVELET_XFORM_5X3_REVERSIBLE) self.assertEqual(len(c.segment[2].spcod), 9) @@ -885,18 +570,10 @@ class TestSuiteDump(unittest.TestCase): self.assertEqual(c.segment[3].exponent, [14, 15, 15, 16, 15, 15, 16, 15, 15, 16]) - # COM: comment - # Registration - self.assertEqual(c.segment[4].rcme, glymur.core.RCME_ISO_8859_1) - # Comment value - self.assertEqual(c.segment[4].ccme.decode('latin-1'), - "Kakadu-3.0.7") + pargs = (RCME_ISO_8859_1, "Kakadu-3.0.7".encode()) + self.verifyCMEsegment(c.segment[4], CMEsegment(*pargs)) - # SOT: start of tile part - self.assertEqual(c.segment[5].isot, 0) - self.assertEqual(c.segment[5].psot, 9951) - self.assertEqual(c.segment[5].tpsot, 0) - self.assertEqual(c.segment[5].tnsot, 0) # unknown + self.verifySOTsegment(c.segment[5], SOTsegment(0, 9951, 0, 0)) # POD: progression order change self.assertEqual(c.segment[6].rspod, (0,)) @@ -908,7 +585,6 @@ class TestSuiteDump(unittest.TestCase): # PLT: packet length, tile part self.assertEqual(c.segment[7].zplt, 0) - #self.assertEqual(c.segment[7].iplt), 99) # SOD: start of data self.assertEqual(c.segment[8].marker_id, 'SOD') @@ -917,25 +593,13 @@ class TestSuiteDump(unittest.TestCase): jfile = opj_data_file('input/conformance/p0_08.j2k') c = Jp2k(jfile).get_codestream(header_only=False) - # SIZ: Image and tile size - # Profile: "1" means profile 0 - self.assertEqual(c.segment[1].rsiz, 1) - # Reference grid size - self.assertEqual(c.segment[1].xsiz, 513) - self.assertEqual(c.segment[1].ysiz, 3072) - # Reference grid offset - self.assertEqual((c.segment[1].xosiz, c.segment[1].yosiz), (0, 0)) - # Tile size - self.assertEqual((c.segment[1].xtsiz, c.segment[1].ytsiz), (513, 3072)) - # Tile offset - self.assertEqual((c.segment[1].xtosiz, c.segment[1].ytosiz), (0, 0)) - # bitdepth - self.assertEqual(c.segment[1].bitdepth, (12, 12, 12)) - # signed - self.assertEqual(c.segment[1].signed, (True, True, True)) - # subsampling - self.assertEqual(list(zip(c.segment[1].xrsiz, c.segment[1].yrsiz)), - [(1, 1), (1, 1), (1, 1)]) + kwargs = {'rsiz': 1, 'xysiz': (513, 3072), 'xyosiz': (0, 0), + 'xytsiz': (513, 3072), 'xytosiz': (0, 0), + 'bitdepth': (12, 12, 12), + 'signed': (True, True, True), + 'xyrsiz': [(1, 1, 1), (1, 1, 1)]} + self.verifySizSegment(c.segment[1], + glymur.codestream.SIZsegment(**kwargs)) # COD: Coding style default self.assertTrue(c.segment[2].scod & 2) @@ -946,18 +610,8 @@ class TestSuiteDump(unittest.TestCase): self.assertEqual(c.segment[2].spcod[4], 7) # levels self.assertEqual(tuple(c.segment[2].code_block_size), (64, 64)) # cblk - # Selective arithmetic coding bypass - self.assertFalse(c.segment[2].spcod[7] & 0x01) - # Reset context probabilities - self.assertFalse(c.segment[2].spcod[7] & 0x02) - # Termination on each coding pass - self.assertFalse(c.segment[2].spcod[7] & 0x04) - # Vertically causal context - self.assertFalse(c.segment[2].spcod[7] & 0x08) - # Predictable termination - self.assertFalse(c.segment[2].spcod[7] & 0x0010) - # Segmentation symbols - self.assertFalse(c.segment[2].spcod[7] & 0x0020) + self.verify_codeblock_style(c.segment[2].spcod[7], + [False, False, False, False, False, False]) self.assertEqual(c.segment[2].spcod[8], glymur.core.WAVELET_XFORM_5X3_REVERSIBLE) self.assertEqual(len(c.segment[2].spcod), 9) @@ -967,18 +621,8 @@ class TestSuiteDump(unittest.TestCase): self.assertEqual(c.segment[3].spcoc[0], 6) # levels self.assertEqual(tuple(c.segment[3].code_block_size), (64, 64)) # cblk - # Selective arithmetic coding bypass - self.assertFalse(c.segment[3].spcoc[3] & 0x01) - # Reset context probabilities - self.assertFalse(c.segment[3].spcoc[3] & 0x02) - # Termination on each coding pass - self.assertFalse(c.segment[3].spcoc[3] & 0x04) - # Vertically causal context - self.assertFalse(c.segment[3].spcoc[3] & 0x08) - # Predictable termination - self.assertFalse(c.segment[3].spcoc[3] & 0x0010) - # Segmentation symbols - self.assertFalse(c.segment[3].spcoc[3] & 0x0020) + self.verify_codeblock_style(c.segment[3].spcoc[3], + [False, False, False, False, False, False]) self.assertEqual(c.segment[3].spcoc[4], glymur.core.WAVELET_XFORM_5X3_REVERSIBLE) @@ -987,18 +631,8 @@ class TestSuiteDump(unittest.TestCase): self.assertEqual(c.segment[4].spcoc[0], 7) # levels self.assertEqual(tuple(c.segment[4].code_block_size), (32, 32)) # cblk - # Selective arithmetic coding bypass - self.assertFalse(c.segment[4].spcoc[3] & 0x01) - # Reset context probabilities - self.assertFalse(c.segment[4].spcoc[3] & 0x02) - # Termination on each coding pass - self.assertFalse(c.segment[4].spcoc[3] & 0x04) - # Vertically causal context - self.assertFalse(c.segment[4].spcoc[3] & 0x08) - # Predictable termination - self.assertFalse(c.segment[4].spcoc[3] & 0x0010) - # Segmentation symbols - self.assertFalse(c.segment[4].spcoc[3] & 0x0020) + self.verify_codeblock_style(c.segment[4].spcoc[3], + [False, False, False, False, False, False]) self.assertEqual(c.segment[4].spcoc[4], glymur.core.WAVELET_XFORM_5X3_REVERSIBLE) @@ -1007,18 +641,8 @@ class TestSuiteDump(unittest.TestCase): self.assertEqual(c.segment[5].spcoc[0], 8) # levels self.assertEqual(tuple(c.segment[5].code_block_size), (64, 64)) # cblk - # Selective arithmetic coding bypass - self.assertFalse(c.segment[5].spcoc[3] & 0x01) - # Reset context probabilities - self.assertFalse(c.segment[5].spcoc[3] & 0x02) - # Termination on each coding pass - self.assertFalse(c.segment[5].spcoc[3] & 0x04) - # Vertically causal context - self.assertFalse(c.segment[5].spcoc[3] & 0x08) - # Predictable termination - self.assertFalse(c.segment[5].spcoc[3] & 0x0010) - # Segmentation symbols - self.assertFalse(c.segment[5].spcoc[3] & 0x0020) + self.verify_codeblock_style(c.segment[5].spcoc[3], + [False, False, False, False, False, False]) self.assertEqual(c.segment[5].spcoc[4], glymur.core.WAVELET_XFORM_5X3_REVERSIBLE) @@ -1053,42 +677,20 @@ class TestSuiteDump(unittest.TestCase): [11, 12, 12, 13, 12, 12, 13, 12, 12, 13, 12, 12, 13, 12, 12, 13, 12, 12, 13, 12, 12, 13, 12, 12, 13]) - # COM: comment - # Registration - self.assertEqual(c.segment[9].rcme, glymur.core.RCME_ISO_8859_1) - # Comment value - self.assertEqual(c.segment[9].ccme.decode('latin-1'), - "Kakadu-3.0.7") + pargs = (RCME_ISO_8859_1, "Kakadu-3.0.7".encode()) + self.verifyCMEsegment(c.segment[9], CMEsegment(*pargs)) - # SOT: start of tile part - self.assertEqual(c.segment[10].isot, 0) - self.assertEqual(c.segment[10].psot, 3820593) - self.assertEqual(c.segment[10].tpsot, 0) - self.assertEqual(c.segment[10].tnsot, 1) # unknown + self.verifySOTsegment(c.segment[10], SOTsegment(0, 3820593, 0, 1)) def test_NR_p0_09_dump(self): jfile = opj_data_file('input/conformance/p0_09.j2k') c = Jp2k(jfile).get_codestream(header_only=False) - # SIZ: Image and tile size - # Profile: "0" means profile 2, or full capabilities - self.assertEqual(c.segment[1].rsiz, 0) - # Reference grid size - self.assertEqual(c.segment[1].xsiz, 17) - self.assertEqual(c.segment[1].ysiz, 37) - # Reference grid offset - self.assertEqual((c.segment[1].xosiz, c.segment[1].yosiz), (0, 0)) - # Tile size - self.assertEqual((c.segment[1].xtsiz, c.segment[1].ytsiz), (17, 37)) - # Tile offset - self.assertEqual((c.segment[1].xtosiz, c.segment[1].ytosiz), (0, 0)) - # bitdepth - self.assertEqual(c.segment[1].bitdepth, (8,)) - # signed - self.assertEqual(c.segment[1].signed, (False,)) - # subsampling - self.assertEqual(list(zip(c.segment[1].xrsiz, c.segment[1].yrsiz)), - [(1, 1)]) + kwargs = {'rsiz': 0, 'xysiz': (17, 37), 'xyosiz': (0, 0), + 'xytsiz': (17, 37), 'xytosiz': (0, 0), 'bitdepth': (8,), + 'signed': (False,), 'xyrsiz': [(1,), (1,)]} + self.verifySizSegment(c.segment[1], + glymur.codestream.SIZsegment(**kwargs)) # COD: Coding style default self.assertFalse(c.segment[2].scod & 2) @@ -1099,18 +701,8 @@ class TestSuiteDump(unittest.TestCase): self.assertEqual(c.segment[2].spcod[4], 5) # levels self.assertEqual(tuple(c.segment[2].code_block_size), (64, 64)) # cblk - # Selective arithmetic coding bypass - self.assertFalse(c.segment[2].spcod[7] & 0x01) - # Reset context probabilities - self.assertFalse(c.segment[2].spcod[7] & 0x02) - # Termination on each coding pass - self.assertFalse(c.segment[2].spcod[7] & 0x04) - # Vertically causal context - self.assertFalse(c.segment[2].spcod[7] & 0x08) - # Predictable termination - self.assertFalse(c.segment[2].spcod[7] & 0x0010) - # Segmentation symbols - self.assertFalse(c.segment[2].spcod[7] & 0x0020) + self.verify_codeblock_style(c.segment[2].spcod[7], + [False, False, False, False, False, False]) self.assertEqual(c.segment[2].spcod[8], glymur.core.WAVELET_XFORM_9X7_IRREVERSIBLE) self.assertEqual(len(c.segment[2].spcod), 9) @@ -1126,18 +718,10 @@ class TestSuiteDump(unittest.TestCase): [16, 16, 16, 16, 15, 15, 15, 14, 14, 14, 12, 12, 12, 11, 11, 12]) - # COM: comment - # Registration - self.assertEqual(c.segment[4].rcme, glymur.core.RCME_ISO_8859_1) - # Comment value - self.assertEqual(c.segment[4].ccme.decode('latin-1'), - "Kakadu-3.0.7") + pargs = (RCME_ISO_8859_1, "Kakadu-3.0.7".encode()) + self.verifyCMEsegment(c.segment[4], CMEsegment(*pargs)) - # SOT: start of tile part - self.assertEqual(c.segment[5].isot, 0) - self.assertEqual(c.segment[5].psot, 478) - self.assertEqual(c.segment[5].tpsot, 0) - self.assertEqual(c.segment[5].tnsot, 1) # unknown + self.verifySOTsegment(c.segment[5], SOTsegment(0, 478, 0, 1)) # SOD: start of data # Just one. @@ -1150,25 +734,13 @@ class TestSuiteDump(unittest.TestCase): jfile = opj_data_file('input/conformance/p0_10.j2k') c = Jp2k(jfile).get_codestream(header_only=False) - # SIZ: Image and tile size - # Profile: "1" means profile 0 - self.assertEqual(c.segment[1].rsiz, 1) - # Reference grid size - self.assertEqual(c.segment[1].xsiz, 256) - self.assertEqual(c.segment[1].ysiz, 256) - # Reference grid offset - self.assertEqual((c.segment[1].xosiz, c.segment[1].yosiz), (0, 0)) - # Tile size - self.assertEqual((c.segment[1].xtsiz, c.segment[1].ytsiz), (128, 128)) - # Tile offset - self.assertEqual((c.segment[1].xtosiz, c.segment[1].ytosiz), (0, 0)) - # bitdepth - self.assertEqual(c.segment[1].bitdepth, (8, 8, 8)) - # signed - self.assertEqual(c.segment[1].signed, (False, False, False)) - # subsampling - self.assertEqual(list(zip(c.segment[1].xrsiz, c.segment[1].yrsiz)), - [(4, 4), (4, 4), (4, 4)]) + kwargs = {'rsiz': 1, 'xysiz': (256, 256), 'xyosiz': (0, 0), + 'xytsiz': (128, 128), 'xytosiz': (0, 0), + 'bitdepth': (8, 8, 8), + 'signed': (False, False, False), + 'xyrsiz': [(4, 4, 4), (4, 4, 4)]} + self.verifySizSegment(c.segment[1], + glymur.codestream.SIZsegment(**kwargs)) # COD: Coding style default self.assertFalse(c.segment[2].scod & 2) @@ -1179,18 +751,8 @@ class TestSuiteDump(unittest.TestCase): self.assertEqual(c.segment[2].spcod[4], 3) # levels self.assertEqual(tuple(c.segment[2].code_block_size), (64, 64)) # cblk - # Selective arithmetic coding bypass - self.assertFalse(c.segment[2].spcod[7] & 0x01) - # Reset context probabilities - self.assertFalse(c.segment[2].spcod[7] & 0x02) - # Termination on each coding pass - self.assertFalse(c.segment[2].spcod[7] & 0x04) - # Vertically causal context - self.assertFalse(c.segment[2].spcod[7] & 0x08) - # Predictable termination - self.assertFalse(c.segment[2].spcod[7] & 0x0010) - # Segmentation symbols - self.assertFalse(c.segment[2].spcod[7] & 0x0020) + self.verify_codeblock_style(c.segment[2].spcod[7], + [False, False, False, False, False, False]) self.assertEqual(c.segment[2].spcod[8], glymur.core.WAVELET_XFORM_5X3_REVERSIBLE) self.assertEqual(len(c.segment[2].spcod), 9) @@ -1203,113 +765,44 @@ class TestSuiteDump(unittest.TestCase): self.assertEqual(c.segment[3].exponent, [11, 12, 12, 13, 12, 12, 13, 12, 12, 13]) - # SOT: start of tile part - self.assertEqual(c.segment[4].isot, 0) - self.assertEqual(c.segment[4].psot, 2453) - self.assertEqual(c.segment[4].tpsot, 0) - self.assertEqual(c.segment[4].tnsot, 0) + self.verifySOTsegment(c.segment[4], SOTsegment(0, 2453, 0, 0)) - # SOD: start of data self.assertEqual(c.segment[5].marker_id, 'SOD') + self.verifySOTsegment(c.segment[6], SOTsegment(1, 2403, 0, 0)) - # SOT: start of tile part - self.assertEqual(c.segment[6].isot, 1) - self.assertEqual(c.segment[6].psot, 2403) - self.assertEqual(c.segment[6].tpsot, 0) - self.assertEqual(c.segment[6].tnsot, 0) - - # SOD: start of data self.assertEqual(c.segment[7].marker_id, 'SOD') + self.verifySOTsegment(c.segment[8], SOTsegment(2, 2420, 0, 0)) - # SOT: start of tile part - self.assertEqual(c.segment[8].isot, 2) - self.assertEqual(c.segment[8].psot, 2420) - self.assertEqual(c.segment[8].tpsot, 0) - self.assertEqual(c.segment[8].tnsot, 0) - - # SOD: start of data self.assertEqual(c.segment[9].marker_id, 'SOD') + self.verifySOTsegment(c.segment[10], SOTsegment(3, 2472, 0, 0)) - # SOT: start of tile part - self.assertEqual(c.segment[10].isot, 3) - self.assertEqual(c.segment[10].psot, 2472) - self.assertEqual(c.segment[10].tpsot, 0) - self.assertEqual(c.segment[10].tnsot, 0) - - # SOD: start of data self.assertEqual(c.segment[11].marker_id, 'SOD') + self.verifySOTsegment(c.segment[12], SOTsegment(0, 1043, 1, 2)) - # SOT: start of tile part - self.assertEqual(c.segment[12].isot, 0) - self.assertEqual(c.segment[12].psot, 1043) - self.assertEqual(c.segment[12].tpsot, 1) - self.assertEqual(c.segment[12].tnsot, 2) - - # SOD: start of data self.assertEqual(c.segment[13].marker_id, 'SOD') + self.verifySOTsegment(c.segment[14], SOTsegment(1, 1101, 1, 2)) - # SOT: start of tile part - self.assertEqual(c.segment[14].isot, 1) - self.assertEqual(c.segment[14].psot, 1101) - self.assertEqual(c.segment[14].tpsot, 1) - self.assertEqual(c.segment[14].tnsot, 2) - - # SOD: start of data self.assertEqual(c.segment[15].marker_id, 'SOD') + self.verifySOTsegment(c.segment[16], SOTsegment(3, 1054, 1, 2)) - # SOT: start of tile part - self.assertEqual(c.segment[16].isot, 3) - self.assertEqual(c.segment[16].psot, 1054) - self.assertEqual(c.segment[16].tpsot, 1) - self.assertEqual(c.segment[16].tnsot, 2) - - # SOD: start of data self.assertEqual(c.segment[17].marker_id, 'SOD') + self.verifySOTsegment(c.segment[18], SOTsegment(2, 14, 1, 0)) - # SOT: start of tile part - self.assertEqual(c.segment[18].isot, 2) - self.assertEqual(c.segment[18].psot, 14) - self.assertEqual(c.segment[18].tpsot, 1) - self.assertEqual(c.segment[18].tnsot, 0) - - # SOD: start of data self.assertEqual(c.segment[19].marker_id, 'SOD') + self.verifySOTsegment(c.segment[20], SOTsegment(2, 1089, 2, 0)) - # SOT: start of tile part - self.assertEqual(c.segment[20].isot, 2) - self.assertEqual(c.segment[20].psot, 1089) - self.assertEqual(c.segment[20].tpsot, 2) - self.assertEqual(c.segment[20].tnsot, 0) - - # SOD: start of data self.assertEqual(c.segment[21].marker_id, 'SOD') - - # EOC: end of codestream self.assertEqual(c.segment[22].marker_id, 'EOC') def test_NR_p0_11_dump(self): jfile = opj_data_file('input/conformance/p0_11.j2k') c = Jp2k(jfile).get_codestream(header_only=False) - # SIZ: Image and tile size - # Profile: "1" means profile 0 - self.assertEqual(c.segment[1].rsiz, 1) - # Reference grid size - self.assertEqual(c.segment[1].xsiz, 128) - self.assertEqual(c.segment[1].ysiz, 1) - # Reference grid offset - self.assertEqual((c.segment[1].xosiz, c.segment[1].yosiz), (0, 0)) - # Tile size - self.assertEqual((c.segment[1].xtsiz, c.segment[1].ytsiz), (128, 128)) - # Tile offset - self.assertEqual((c.segment[1].xtosiz, c.segment[1].ytosiz), (0, 0)) - # bitdepth - self.assertEqual(c.segment[1].bitdepth, (8,)) - # signed - self.assertEqual(c.segment[1].signed, (False,)) - # subsampling - self.assertEqual(list(zip(c.segment[1].xrsiz, c.segment[1].yrsiz)), - [(1, 1)]) + kwargs = {'rsiz': 1, 'xysiz': (128, 1), 'xyosiz': (0, 0), + 'xytsiz': (128, 128), 'xytosiz': (0, 0), 'bitdepth': (8,), + 'signed': (False,), 'xyrsiz': [(1,), (1,)]} + self.verifySizSegment(c.segment[1], + glymur.codestream.SIZsegment(**kwargs)) # COD: Coding style default self.assertFalse(c.segment[2].scod & 2) @@ -1320,18 +813,8 @@ class TestSuiteDump(unittest.TestCase): self.assertEqual(c.segment[2].spcod[4], 0) # levels self.assertEqual(tuple(c.segment[2].code_block_size), (64, 64)) # cblk - # Selective arithmetic coding bypass - self.assertFalse(c.segment[2].spcod[7] & 0x01) - # Reset context probabilities - self.assertFalse(c.segment[2].spcod[7] & 0x02) - # Termination on each coding pass - self.assertFalse(c.segment[2].spcod[7] & 0x04) - # Vertically causal context - self.assertFalse(c.segment[2].spcod[7] & 0x08) - # Predictable termination - self.assertFalse(c.segment[2].spcod[7] & 0x0010) - # Segmentation symbols - self.assertTrue(c.segment[2].spcod[7] & 0x0020) + self.verify_codeblock_style(c.segment[2].spcod[7], + [False, False, False, False, False, True]) self.assertEqual(c.segment[2].spcod[8], glymur.core.WAVELET_XFORM_5X3_REVERSIBLE) self.assertEqual(c.segment[2].precinct_size, [(128, 2)]) @@ -1343,18 +826,11 @@ class TestSuiteDump(unittest.TestCase): self.assertEqual(c.segment[3].mantissa, [0]) self.assertEqual(c.segment[3].exponent, [8]) - # COM: comment - # Registration - self.assertEqual(c.segment[4].rcme, glymur.core.RCME_ISO_8859_1) - # Comment value - self.assertEqual(c.segment[4].ccme.decode('latin-1'), - "Creator: AV-J2K (c) 2000,2001 Algo Vision") + pargs = (RCME_ISO_8859_1, + "Creator: AV-J2K (c) 2000,2001 Algo Vision".encode()) + self.verifyCMEsegment(c.segment[4], CMEsegment(*pargs)) - # SOT: start of tile part - self.assertEqual(c.segment[5].isot, 0) - self.assertEqual(c.segment[5].psot, 118) - self.assertEqual(c.segment[5].tpsot, 0) - self.assertEqual(c.segment[5].tnsot, 1) + self.verifySOTsegment(c.segment[5], SOTsegment(0, 118, 0, 1)) # SOD: start of data self.assertEqual(c.segment[6].marker_id, 'SOD') @@ -1372,25 +848,12 @@ class TestSuiteDump(unittest.TestCase): jfile = opj_data_file('input/conformance/p0_12.j2k') c = Jp2k(jfile).get_codestream(header_only=False) - # SIZ: Image and tile size - # Profile: "1" means profile 0 - self.assertEqual(c.segment[1].rsiz, 1) - # Reference grid size - self.assertEqual(c.segment[1].xsiz, 3) - self.assertEqual(c.segment[1].ysiz, 5) - # Reference grid offset - self.assertEqual((c.segment[1].xosiz, c.segment[1].yosiz), (0, 0)) - # Tile size - self.assertEqual((c.segment[1].xtsiz, c.segment[1].ytsiz), (3, 5)) - # Tile offset - self.assertEqual((c.segment[1].xtosiz, c.segment[1].ytosiz), (0, 0)) - # bitdepth - self.assertEqual(c.segment[1].bitdepth, (8,)) - # signed - self.assertEqual(c.segment[1].signed, (False,)) - # subsampling - self.assertEqual(list(zip(c.segment[1].xrsiz, c.segment[1].yrsiz)), - [(1, 1)]) + kwargs = {'rsiz': 1, 'xysiz': (3, 5), 'xyosiz': (0, 0), + 'xytsiz': (3, 5), 'xytosiz': (0, 0), 'bitdepth': (8,), + 'signed': (False,), + 'xyrsiz': [(1,), (1,)]} + self.verifySizSegment(c.segment[1], + glymur.codestream.SIZsegment(**kwargs)) # COD: Coding style default self.assertTrue(c.segment[2].scod & 2) @@ -1401,18 +864,8 @@ class TestSuiteDump(unittest.TestCase): self.assertEqual(c.segment[2].spcod[4], 3) # levels self.assertEqual(tuple(c.segment[2].code_block_size), (32, 32)) # cblk - # Selective arithmetic coding bypass - self.assertFalse(c.segment[2].spcod[7] & 0x01) - # Reset context probabilities - self.assertFalse(c.segment[2].spcod[7] & 0x02) - # Termination on each coding pass - self.assertTrue(c.segment[2].spcod[7] & 0x04) - # Vertically causal context - self.assertFalse(c.segment[2].spcod[7] & 0x08) - # Predictable termination - self.assertFalse(c.segment[2].spcod[7] & 0x0010) - # Segmentation symbols - self.assertFalse(c.segment[2].spcod[7] & 0x0020) + self.verify_codeblock_style(c.segment[2].spcod[7], + [False, False, True, False, False, False]) self.assertEqual(c.segment[2].spcod[8], glymur.core.WAVELET_XFORM_5X3_REVERSIBLE) self.assertEqual(len(c.segment[2].spcod), 9) @@ -1425,18 +878,11 @@ class TestSuiteDump(unittest.TestCase): self.assertEqual(c.segment[3].exponent, [8, 9, 9, 10, 9, 9, 10, 9, 9, 10]) - # COM: comment - # Registration - self.assertEqual(c.segment[4].rcme, glymur.core.RCME_ISO_8859_1) - # Comment value - self.assertEqual(c.segment[4].ccme.decode('latin-1'), - "Creator: AV-J2K (c) 2000,2001 Algo Vision") + pargs = (RCME_ISO_8859_1, + "Creator: AV-J2K (c) 2000,2001 Algo Vision".encode()) + self.verifyCMEsegment(c.segment[4], CMEsegment(*pargs)) - # SOT: start of tile part - self.assertEqual(c.segment[5].isot, 0) - self.assertEqual(c.segment[5].psot, 162) - self.assertEqual(c.segment[5].tpsot, 0) - self.assertEqual(c.segment[5].tnsot, 1) + self.verifySOTsegment(c.segment[5], SOTsegment(0, 162, 0, 1)) # SOD: start of data self.assertEqual(c.segment[6].marker_id, 'SOD') @@ -1454,25 +900,13 @@ class TestSuiteDump(unittest.TestCase): jfile = opj_data_file('input/conformance/p0_13.j2k') c = Jp2k(jfile).get_codestream(header_only=False) - # SIZ: Image and tile size - # Profile: "1" means profile 0 - self.assertEqual(c.segment[1].rsiz, 1) - # Reference grid size - self.assertEqual(c.segment[1].xsiz, 1) - self.assertEqual(c.segment[1].ysiz, 1) - # Reference grid offset - self.assertEqual((c.segment[1].xosiz, c.segment[1].yosiz), (0, 0)) - # Tile size - self.assertEqual((c.segment[1].xtsiz, c.segment[1].ytsiz), (1, 1)) - # Tile offset - self.assertEqual((c.segment[1].xtosiz, c.segment[1].ytosiz), (0, 0)) - # bitdepth - self.assertEqual(c.segment[1].bitdepth, tuple([8] * 257)) - # signed - self.assertEqual(c.segment[1].signed, tuple([False] * 257)) - # subsampling - self.assertEqual(list(zip(c.segment[1].xrsiz, c.segment[1].yrsiz)), - [(1, 1)] * 257) + kwargs = {'rsiz': 1, 'xysiz': (1, 1), 'xyosiz': (0, 0), + 'xytsiz': (1, 1), 'xytosiz': (0, 0), + 'bitdepth': tuple([8] * 257), + 'signed': tuple([False] * 257), + 'xyrsiz': [tuple([1] * 257), tuple([1] * 257)]} + self.verifySizSegment(c.segment[1], + glymur.codestream.SIZsegment(**kwargs)) # COD: Coding style default self.assertFalse(c.segment[2].scod & 2) # no sop @@ -1482,18 +916,8 @@ class TestSuiteDump(unittest.TestCase): self.assertEqual(c.segment[2].spcod[3], 1) # mct self.assertEqual(c.segment[2].spcod[4], 1) # levels self.assertEqual(tuple(c.segment[2].code_block_size), (32, 32)) - # Selective arithmetic coding bypass - self.assertFalse(c.segment[2].spcod[7] & 0x01) - # Reset context probabilities - self.assertFalse(c.segment[2].spcod[7] & 0x02) - # Termination on each coding pass - self.assertFalse(c.segment[2].spcod[7] & 0x04) - # Vertically causal context - self.assertFalse(c.segment[2].spcod[7] & 0x08) - # Predictable termination - self.assertTrue(c.segment[2].spcod[7] & 0x0010) - # Segmentation symbols - self.assertFalse(c.segment[2].spcod[7] & 0x0020) + self.verify_codeblock_style(c.segment[2].spcod[7], + [False, False, False, False, True, False]) self.assertEqual(c.segment[2].spcod[8], glymur.core.WAVELET_XFORM_5X3_REVERSIBLE) self.assertEqual(len(c.segment[2].spcod), 9) @@ -1502,18 +926,8 @@ class TestSuiteDump(unittest.TestCase): self.assertEqual(c.segment[3].ccoc, 2) self.assertEqual(c.segment[3].spcoc[0], 1) # levels self.assertEqual(tuple(c.segment[3].code_block_size), (64, 64)) - # Selective arithmetic coding bypass - self.assertFalse(c.segment[3].spcoc[3] & 0x01) - # Reset context probabilities - self.assertFalse(c.segment[3].spcoc[3] & 0x02) - # Termination on each coding pass - self.assertFalse(c.segment[3].spcoc[3] & 0x04) - # Vertically causal context - self.assertFalse(c.segment[3].spcoc[3] & 0x08) - # Predictable termination - self.assertFalse(c.segment[3].spcoc[3] & 0x0010) - # Segmentation symbols - self.assertFalse(c.segment[3].spcoc[3] & 0x0020) + self.verify_codeblock_style(c.segment[3].spcoc[3], + [False, False, False, False, False, False]) self.assertEqual(c.segment[3].spcoc[4], glymur.core.WAVELET_XFORM_5X3_REVERSIBLE) @@ -1543,10 +957,7 @@ class TestSuiteDump(unittest.TestCase): self.assertEqual(c.segment[6].exponent, [9, 10, 10, 11]) self.assertEqual(c.segment[6].mantissa, [0, 0, 0, 0]) - # RGN: region of interest - self.assertEqual(c.segment[7].crgn, 3) - self.assertEqual(c.segment[7].srgn, 0) - self.assertEqual(c.segment[7].sprgn, 11) + self.verifyRGNsegment(c.segment[7], RGNsegment(3, 0, 11)) # POD: progression order change self.assertEqual(c.segment[8].rspod, (0, 0)) @@ -1557,18 +968,11 @@ class TestSuiteDump(unittest.TestCase): self.assertEqual(c.segment[8].ppod, (glymur.core.RLCP, glymur.core.CPRL)) - # COM: comment - # Registration - self.assertEqual(c.segment[9].rcme, glymur.core.RCME_ISO_8859_1) - # Comment value - self.assertEqual(c.segment[9].ccme.decode('latin-1'), - "Creator: AV-J2K (c) 2000,2001 Algo Vision") + pargs = (RCME_ISO_8859_1, + "Creator: AV-J2K (c) 2000,2001 Algo Vision".encode()) + self.verifyCMEsegment(c.segment[9], CMEsegment(*pargs)) - # SOT: start of tile part - self.assertEqual(c.segment[10].isot, 0) - self.assertEqual(c.segment[10].psot, 1537) - self.assertEqual(c.segment[10].tpsot, 0) - self.assertEqual(c.segment[10].tnsot, 1) + self.verifySOTsegment(c.segment[10], SOTsegment(0, 1537, 0, 1)) # SOD: start of data self.assertEqual(c.segment[11].marker_id, 'SOD') @@ -1580,25 +984,12 @@ class TestSuiteDump(unittest.TestCase): jfile = opj_data_file('input/conformance/p0_14.j2k') c = Jp2k(jfile).get_codestream(header_only=False) - # SIZ: Image and tile size - # Profile: "0" means profile 2 - self.assertEqual(c.segment[1].rsiz, 0) - # Reference grid size - self.assertEqual(c.segment[1].xsiz, 49) - self.assertEqual(c.segment[1].ysiz, 49) - # Reference grid offset - self.assertEqual((c.segment[1].xosiz, c.segment[1].yosiz), (0, 0)) - # Tile size - self.assertEqual((c.segment[1].xtsiz, c.segment[1].ytsiz), (49, 49)) - # Tile offset - self.assertEqual((c.segment[1].xtosiz, c.segment[1].ytosiz), (0, 0)) - # bitdepth - self.assertEqual(c.segment[1].bitdepth, (8, 8, 8)) - # signed - self.assertEqual(c.segment[1].signed, (False, False, False)) - # subsampling - self.assertEqual(list(zip(c.segment[1].xrsiz, c.segment[1].yrsiz)), - [(1, 1)] * 3) + kwargs = {'rsiz': 0, 'xysiz': (49, 49), 'xyosiz': (0, 0), + 'xytsiz': (49, 49), 'xytosiz': (0, 0), 'bitdepth': (8, 8, 8), + 'signed': (False, False, False), + 'xyrsiz': [(1, 1, 1), (1, 1, 1)]} + self.verifySizSegment(c.segment[1], + glymur.codestream.SIZsegment(**kwargs)) # COD: Coding style default self.assertFalse(c.segment[2].scod & 2) @@ -1608,18 +999,8 @@ class TestSuiteDump(unittest.TestCase): self.assertEqual(c.segment[2].spcod[3], 1) # mct self.assertEqual(c.segment[2].spcod[4], 5) # levels self.assertEqual(tuple(c.segment[2].code_block_size), (64, 64)) - # Selective arithmetic coding bypass - self.assertFalse(c.segment[2].spcod[7] & 0x01) - # Reset context probabilities - self.assertFalse(c.segment[2].spcod[7] & 0x02) - # Termination on each coding pass - self.assertFalse(c.segment[2].spcod[7] & 0x04) - # Vertically causal context - self.assertFalse(c.segment[2].spcod[7] & 0x08) - # Predictable termination - self.assertFalse(c.segment[2].spcod[7] & 0x0010) - # Segmentation symbols - self.assertFalse(c.segment[2].spcod[7] & 0x0020) + self.verify_codeblock_style(c.segment[2].spcod[7], + [False, False, False, False, False, False]) self.assertEqual(c.segment[2].spcod[8], glymur.core.WAVELET_XFORM_5X3_REVERSIBLE) self.assertEqual(len(c.segment[2].spcod), 9) @@ -1633,48 +1014,23 @@ class TestSuiteDump(unittest.TestCase): [10, 11, 11, 12, 11, 11, 12, 11, 11, 12, 11, 11, 12, 11, 11, 12]) - # COM: comment - # Registration - self.assertEqual(c.segment[4].rcme, glymur.core.RCME_ISO_8859_1) - # Comment value - self.assertEqual(c.segment[4].ccme.decode('latin-1'), - "Kakadu-3.0.7") + pargs = (RCME_ISO_8859_1, "Kakadu-3.0.7".encode()) + self.verifyCMEsegment(c.segment[4], CMEsegment(*pargs)) - # SOT: start of tile part - self.assertEqual(c.segment[5].isot, 0) - self.assertEqual(c.segment[5].psot, 1528) - self.assertEqual(c.segment[5].tpsot, 0) - self.assertEqual(c.segment[5].tnsot, 1) - - # SOD: start of data + self.verifySOTsegment(c.segment[5], SOTsegment(0, 1528, 0, 1)) self.assertEqual(c.segment[6].marker_id, 'SOD') - - # EOC: end of codestream self.assertEqual(c.segment[7].marker_id, 'EOC') def test_NR_p0_15_dump(self): jfile = opj_data_file('input/conformance/p0_15.j2k') c = Jp2k(jfile).get_codestream(header_only=False) - # SIZ: Image and tile size - # Profile: "1" means profile 0 - self.assertEqual(c.segment[1].rsiz, 1) - # Reference grid size - self.assertEqual(c.segment[1].xsiz, 256) - self.assertEqual(c.segment[1].ysiz, 256) - # Reference grid offset - self.assertEqual((c.segment[1].xosiz, c.segment[1].yosiz), (0, 0)) - # Tile size - self.assertEqual((c.segment[1].xtsiz, c.segment[1].ytsiz), (128, 128)) - # Tile offset - self.assertEqual((c.segment[1].xtosiz, c.segment[1].ytosiz), (0, 0)) - # bitdepth - self.assertEqual(c.segment[1].bitdepth, (4,)) - # signed - self.assertEqual(c.segment[1].signed, (True,)) - # subsampling - self.assertEqual(list(zip(c.segment[1].xrsiz, c.segment[1].yrsiz)), - [(1, 1)]) + kwargs = {'rsiz': 1, 'xysiz': (256, 256), 'xyosiz': (0, 0), + 'xytsiz': (128, 128), 'xytosiz': (0, 0), 'bitdepth': (4,), + 'signed': (True,), + 'xyrsiz': [(1,), (1,)]} + self.verifySizSegment(c.segment[1], + glymur.codestream.SIZsegment(**kwargs)) # COD: Coding style default self.assertTrue(c.segment[2].scod & 2) @@ -1684,18 +1040,8 @@ class TestSuiteDump(unittest.TestCase): self.assertEqual(c.segment[2].spcod[3], 0) # mct self.assertEqual(c.segment[2].spcod[4], 1) # levels self.assertEqual(tuple(c.segment[2].code_block_size), (64, 64)) - # Selective arithmetic coding bypass - self.assertFalse(c.segment[2].spcod[7] & 0x01) - # Reset context probabilities - self.assertFalse(c.segment[2].spcod[7] & 0x02) - # Termination on each coding pass - self.assertFalse(c.segment[2].spcod[7] & 0x04) - # Vertically causal context - self.assertFalse(c.segment[2].spcod[7] & 0x08) - # Predictable termination - self.assertFalse(c.segment[2].spcod[7] & 0x0010) - # Segmentation symbols - self.assertFalse(c.segment[2].spcod[7] & 0x0020) + self.verify_codeblock_style(c.segment[2].spcod[7], + [False, False, False, False, False, False]) self.assertEqual(c.segment[2].spcod[8], glymur.core.WAVELET_XFORM_5X3_REVERSIBLE) self.assertEqual(len(c.segment[2].spcod), 9) @@ -1728,75 +1074,45 @@ class TestSuiteDump(unittest.TestCase): self.assertEqual(c.segment[6].xcrg, (65424,)) self.assertEqual(c.segment[6].ycrg, (32558,)) - # COM: comment - # Registration - self.assertEqual(c.segment[7].rcme, glymur.core.RCME_ISO_8859_1) - # Comment value - self.assertEqual(c.segment[7].ccme.decode('latin-1'), - "Creator: AV-J2K (c) 2000,2001 Algo Vision") + pargs = (RCME_ISO_8859_1, + "Creator: AV-J2K (c) 2000,2001 Algo Vision".encode()) + self.verifyCMEsegment(c.segment[7], CMEsegment(*pargs)) - # COM: comment - # Registration - self.assertEqual(c.segment[8].rcme, glymur.core.RCME_ISO_8859_1) - # Comment value - self.assertEqual(c.segment[8].ccme.decode('latin-1'), - "Creator: AV-J2K (c) 2000," - + "2001 Algo Vision Technology") + pargs = (RCME_ISO_8859_1, comment1.encode()) + self.verifyCMEsegment(c.segment[8], CMEsegment(*pargs)) - # COM: comment - # Registration - self.assertEqual(c.segment[9].rcme, glymur.core.RCME_BINARY) - # Comment value - self.assertEqual(len(c.segment[9].ccme), 62) + pargs = (RCME_BINARY, c.segment[9].ccme) + self.verifyCMEsegment(c.segment[9], CMEsegment(*pargs)) # TLM: tile-part length self.assertEqual(c.segment[10].ztlm, 0) self.assertEqual(c.segment[10].ttlm, (0, 1, 2, 3)) self.assertEqual(c.segment[10].ptlm, (4267, 2117, 4080, 2081)) - # SOT: start of tile part - self.assertEqual(c.segment[11].isot, 0) - self.assertEqual(c.segment[11].psot, 4267) - self.assertEqual(c.segment[11].tpsot, 0) - self.assertEqual(c.segment[11].tnsot, 1) + self.verifySOTsegment(c.segment[11], SOTsegment(0, 4267, 0, 1)) - # RGN: region of interest - self.assertEqual(c.segment[12].crgn, 0) - self.assertEqual(c.segment[12].srgn, 0) - self.assertEqual(c.segment[12].sprgn, 7) + self.verifyRGNsegment(c.segment[12], RGNsegment(0, 0, 7)) # SOD: start of data self.assertEqual(c.segment[13].marker_id, 'SOD') # 16 SOP markers would be here if we were looking for them - # SOT: start of tile part - self.assertEqual(c.segment[31].isot, 1) - self.assertEqual(c.segment[31].psot, 2117) - self.assertEqual(c.segment[31].tpsot, 0) - self.assertEqual(c.segment[31].tnsot, 1) + self.verifySOTsegment(c.segment[31], SOTsegment(1, 2117, 0, 1)) # SOD: start of data self.assertEqual(c.segment[32].marker_id, 'SOD') # 16 SOP markers would be here if we were looking for them - # SOT: start of tile part - self.assertEqual(c.segment[49].isot, 2) - self.assertEqual(c.segment[49].psot, 4080) - self.assertEqual(c.segment[49].tpsot, 0) - self.assertEqual(c.segment[49].tnsot, 1) + self.verifySOTsegment(c.segment[49], SOTsegment(2, 4080, 0, 1)) # SOD: start of data self.assertEqual(c.segment[50].marker_id, 'SOD') # 16 SOP markers would be here if we were looking for them - # SOT: start of tile part - self.assertEqual(c.segment[67].isot, 3) - self.assertEqual(c.segment[67].psot, 2081) - self.assertEqual(c.segment[67].tpsot, 0) - self.assertEqual(c.segment[67].tnsot, 1) + self.verifySOTsegment(c.segment[67], SOTsegment(3, 2081, 0, 1)) # SOD: start of data self.assertEqual(c.segment[68].marker_id, 'SOD') @@ -1810,25 +1126,12 @@ class TestSuiteDump(unittest.TestCase): jfile = opj_data_file('input/conformance/p0_16.j2k') c = Jp2k(jfile).get_codestream(header_only=False) - # SIZ: Image and tile size - # Profile: "0" means profile 2 - self.assertEqual(c.segment[1].rsiz, 0) - # Reference grid size - self.assertEqual(c.segment[1].xsiz, 128) - self.assertEqual(c.segment[1].ysiz, 128) - # Reference grid offset - self.assertEqual((c.segment[1].xosiz, c.segment[1].yosiz), (0, 0)) - # Tile size - self.assertEqual((c.segment[1].xtsiz, c.segment[1].ytsiz), (128, 128)) - # Tile offset - self.assertEqual((c.segment[1].xtosiz, c.segment[1].ytosiz), (0, 0)) - # bitdepth - self.assertEqual(c.segment[1].bitdepth, (8,)) - # signed - self.assertEqual(c.segment[1].signed, (False,)) - # subsampling - self.assertEqual(list(zip(c.segment[1].xrsiz, c.segment[1].yrsiz)), - [(1, 1)]) + kwargs = {'rsiz': 0, 'xysiz': (128, 128), 'xyosiz': (0, 0), + 'xytsiz': (128, 128), 'xytosiz': (0, 0), 'bitdepth': (8,), + 'signed': (False,), + 'xyrsiz': [(1,), (1,)]} + self.verifySizSegment(c.segment[1], + glymur.codestream.SIZsegment(**kwargs)) # COD: Coding style default self.assertFalse(c.segment[2].scod & 2) @@ -1838,18 +1141,8 @@ class TestSuiteDump(unittest.TestCase): self.assertEqual(c.segment[2].spcod[3], 0) # mct self.assertEqual(c.segment[2].spcod[4], 3) # levels self.assertEqual(tuple(c.segment[2].code_block_size), (64, 64)) - # Selective arithmetic coding bypass - self.assertFalse(c.segment[2].spcod[7] & 0x01) - # Reset context probabilities - self.assertFalse(c.segment[2].spcod[7] & 0x02) - # Termination on each coding pass - self.assertFalse(c.segment[2].spcod[7] & 0x04) - # Vertically causal context - self.assertFalse(c.segment[2].spcod[7] & 0x08) - # Predictable termination - self.assertFalse(c.segment[2].spcod[7] & 0x0010) - # Segmentation symbols - self.assertFalse(c.segment[2].spcod[7] & 0x0020) + self.verify_codeblock_style(c.segment[2].spcod[7], + [False, False, False, False, False, False]) self.assertEqual(c.segment[2].spcod[8], glymur.core.WAVELET_XFORM_5X3_REVERSIBLE) self.assertEqual(len(c.segment[2].spcod), 9) @@ -1862,11 +1155,7 @@ class TestSuiteDump(unittest.TestCase): self.assertEqual(c.segment[3].exponent, [8, 9, 9, 10, 9, 9, 10, 9, 9, 10]) - # SOT: start of tile part - self.assertEqual(c.segment[4].isot, 0) - self.assertEqual(c.segment[4].psot, 7331) - self.assertEqual(c.segment[4].tpsot, 0) - self.assertEqual(c.segment[4].tnsot, 1) + self.verifySOTsegment(c.segment[4], SOTsegment(0, 7331, 0, 1)) # SOD: start of data self.assertEqual(c.segment[5].marker_id, 'SOD') @@ -1878,25 +1167,12 @@ class TestSuiteDump(unittest.TestCase): jfile = opj_data_file('input/conformance/p1_01.j2k') c = Jp2k(jfile).get_codestream(header_only=False) - # SIZ: Image and tile size - # Profile: "1" means profile 1 - self.assertEqual(c.segment[1].rsiz, 2) - # Reference grid size - self.assertEqual(c.segment[1].xsiz, 127) - self.assertEqual(c.segment[1].ysiz, 227) - # Reference grid offset - self.assertEqual((c.segment[1].xosiz, c.segment[1].yosiz), (5, 128)) - # Tile size - self.assertEqual((c.segment[1].xtsiz, c.segment[1].ytsiz), (127, 126)) - # Tile offset - self.assertEqual((c.segment[1].xtosiz, c.segment[1].ytosiz), (1, 101)) - # bitdepth - self.assertEqual(c.segment[1].bitdepth, (8,)) - # signed - self.assertEqual(c.segment[1].signed, (False,)) - # subsampling - self.assertEqual(list(zip(c.segment[1].xrsiz, c.segment[1].yrsiz)), - [(2, 1)]) + kwargs = {'rsiz': 2, 'xysiz': (127, 227), 'xyosiz': (5, 128), + 'xytsiz': (127, 126), 'xytosiz': (1, 101), 'bitdepth': (8,), + 'signed': (False,), + 'xyrsiz': [(2,), (1,)]} + self.verifySizSegment(c.segment[1], + glymur.codestream.SIZsegment(**kwargs)) # COD: Coding style default self.assertTrue(c.segment[2].scod & 2) # SOP @@ -1906,18 +1182,8 @@ class TestSuiteDump(unittest.TestCase): self.assertEqual(c.segment[2].spcod[3], 0) # mct self.assertEqual(c.segment[2].spcod[4], 3) # level self.assertEqual(tuple(c.segment[2].code_block_size), (64, 64)) - # Selective arithmetic coding bypass - self.assertFalse(c.segment[2].spcod[7] & 0x01) - # Reset context probabilities - self.assertFalse(c.segment[2].spcod[7] & 0x02) - # Termination on each coding pass - self.assertTrue(c.segment[2].spcod[7] & 0x04) - # Vertically causal context - self.assertFalse(c.segment[2].spcod[7] & 0x08) - # Predictable termination - self.assertTrue(c.segment[2].spcod[7] & 0x0010) - # Segmentation symbols - self.assertTrue(c.segment[2].spcod[7] & 0x0020) + self.verify_codeblock_style(c.segment[2].spcod[7], + [False, False, True, False, True, True]) self.assertEqual(c.segment[2].spcod[8], glymur.core.WAVELET_XFORM_9X7_IRREVERSIBLE) self.assertEqual(len(c.segment[2].spcod), 9) @@ -1926,18 +1192,8 @@ class TestSuiteDump(unittest.TestCase): self.assertEqual(c.segment[3].ccoc, 0) self.assertEqual(c.segment[3].spcoc[0], 3) # level self.assertEqual(tuple(c.segment[3].code_block_size), (32, 32)) - # Selective arithmetic coding bypass - self.assertFalse(c.segment[3].spcoc[3] & 0x01) - # Reset context probabilities - self.assertFalse(c.segment[3].spcoc[3] & 0x02) - # Termination on each coding pass - self.assertTrue(c.segment[3].spcoc[3] & 0x04) - # Vertically causal context - self.assertFalse(c.segment[3].spcoc[3] & 0x08) - # Predictable termination - self.assertTrue(c.segment[3].spcoc[3] & 0x0010) - # Segmentation symbols - self.assertTrue(c.segment[3].spcoc[3] & 0x0020) + self.verify_codeblock_style(c.segment[3].spcoc[3], + [False, False, True, False, True, True]) self.assertEqual(c.segment[3].spcoc[4], glymur.core.WAVELET_XFORM_5X3_REVERSIBLE) @@ -1949,18 +1205,11 @@ class TestSuiteDump(unittest.TestCase): self.assertEqual(c.segment[4].exponent, [8, 9, 9, 10, 9, 9, 10, 9, 9, 10]) - # COM: comment - # Registration - self.assertEqual(c.segment[5].rcme, glymur.core.RCME_ISO_8859_1) - # Comment value - self.assertEqual(c.segment[5].ccme.decode('latin-1'), - "Creator: AV-J2K (c) 2000,2001 Algo Vision") + pargs = (RCME_ISO_8859_1, + "Creator: AV-J2K (c) 2000,2001 Algo Vision".encode()) + self.verifyCMEsegment(c.segment[5], CMEsegment(*pargs)) - # SOT: start of tile part - self.assertEqual(c.segment[6].isot, 0) - self.assertEqual(c.segment[6].psot, 4627) - self.assertEqual(c.segment[6].tpsot, 0) - self.assertEqual(c.segment[6].tnsot, 1) + self.verifySOTsegment(c.segment[6], SOTsegment(0, 4627, 0, 1)) # SOD: start of data self.assertEqual(c.segment[7].marker_id, 'SOD') @@ -1978,25 +1227,13 @@ class TestSuiteDump(unittest.TestCase): jfile = opj_data_file('input/conformance/p1_02.j2k') c = Jp2k(jfile).get_codestream(header_only=False) - # SIZ: Image and tile size - # Profile: "1" means profile 1 - self.assertEqual(c.segment[1].rsiz, 2) - # Reference grid size - self.assertEqual(c.segment[1].xsiz, 640) - self.assertEqual(c.segment[1].ysiz, 480) - # Reference grid offset - self.assertEqual((c.segment[1].xosiz, c.segment[1].yosiz), (0, 0)) - # Tile size - self.assertEqual((c.segment[1].xtsiz, c.segment[1].ytsiz), (640, 480)) - # Tile offset - self.assertEqual((c.segment[1].xtosiz, c.segment[1].ytosiz), (0, 0)) - # bitdepth - self.assertEqual(c.segment[1].bitdepth, tuple([8] * 3)) - # signed - self.assertEqual(c.segment[1].signed, tuple([False] * 3)) - # subsampling - self.assertEqual(list(zip(c.segment[1].xrsiz, c.segment[1].yrsiz)), - [(1, 1)] * 3) + kwargs = {'rsiz': 2, 'xysiz': (640, 480), 'xyosiz': (0, 0), + 'xytsiz': (640, 480), 'xytosiz': (0, 0), + 'bitdepth': (8, 8, 8), + 'signed': (False, False, False), + 'xyrsiz': [(1, 1, 1), (1, 1, 1)]} + self.verifySizSegment(c.segment[1], + glymur.codestream.SIZsegment(**kwargs)) # COD: Coding style default self.assertFalse(c.segment[2].scod & 2) # no sop @@ -2007,18 +1244,8 @@ class TestSuiteDump(unittest.TestCase): self.assertEqual(c.segment[2].spcod[4], 6) # level self.assertEqual(tuple(c.segment[2].code_block_size), (64, 64)) # cblk - # Selective arithmetic coding bypass - self.assertFalse(c.segment[2].spcod[7] & 0x01) - # Reset context probabilities - self.assertTrue(c.segment[2].spcod[7] & 0x02) - # Termination on each coding pass - self.assertFalse(c.segment[2].spcod[7] & 0x04) - # Vertically causal context - self.assertTrue(c.segment[2].spcod[7] & 0x08) - # Predictable termination - self.assertFalse(c.segment[2].spcod[7] & 0x0010) - # Segmentation symbols - self.assertFalse(c.segment[2].spcod[7] & 0x0020) + self.verify_codeblock_style(c.segment[2].spcod[7], + [False, True, False, True, False, False]) self.assertEqual(c.segment[2].spcod[8], glymur.core.WAVELET_XFORM_9X7_IRREVERSIBLE) self.assertEqual(c.segment[2].precinct_size, @@ -2065,18 +1292,11 @@ class TestSuiteDump(unittest.TestCase): [14, 14, 14, 14, 13, 13, 13, 12, 12, 12, 11, 11, 11, 9, 9, 9, 9, 9, 9]) - # COM: comment - # Registration - self.assertEqual(c.segment[6].rcme, glymur.core.RCME_ISO_8859_1) - # Comment value - self.assertEqual(c.segment[6].ccme.decode('latin-1'), - "Creator: AV-J2K (c) 2000,2001 Algo Vision") + pargs = (RCME_ISO_8859_1, + "Creator: AV-J2K (c) 2000,2001 Algo Vision".encode()) + self.verifyCMEsegment(c.segment[6], CMEsegment(*pargs)) - # SOT: start of tile part - self.assertEqual(c.segment[7].isot, 0) - self.assertEqual(c.segment[7].psot, 262838) - self.assertEqual(c.segment[7].tpsot, 0) - self.assertEqual(c.segment[7].tnsot, 1) + self.verifySOTsegment(c.segment[7], SOTsegment(0, 262838, 0, 1)) # PPT: packed packet headers, tile-part header self.assertEqual(c.segment[8].marker_id, 'PPT') @@ -2092,26 +1312,13 @@ class TestSuiteDump(unittest.TestCase): jfile = opj_data_file('input/conformance/p1_03.j2k') c = Jp2k(jfile).get_codestream(header_only=False) - # SIZ: Image and tile size - # Profile: "1" means profile 1 - self.assertEqual(c.segment[1].rsiz, 2) - # Reference grid size - self.assertEqual(c.segment[1].xsiz, 1024) - self.assertEqual(c.segment[1].ysiz, 1024) - # Reference grid offset - self.assertEqual((c.segment[1].xosiz, c.segment[1].yosiz), (0, 0)) - # Tile size - self.assertEqual((c.segment[1].xtsiz, c.segment[1].ytsiz), - (1024, 1024)) - # Tile offset - self.assertEqual((c.segment[1].xtosiz, c.segment[1].ytosiz), (0, 0)) - # bitdepth - self.assertEqual(c.segment[1].bitdepth, tuple([8] * 4)) - # signed - self.assertEqual(c.segment[1].signed, tuple([False] * 4)) - # subsampling - self.assertEqual(list(zip(c.segment[1].xrsiz, c.segment[1].yrsiz)), - [(1, 1), (1, 1), (2, 2), (2, 2)]) + kwargs = {'rsiz': 2, 'xysiz': (1024, 1024), 'xyosiz': (0, 0), + 'xytsiz': (1024, 1024), 'xytosiz': (0, 0), + 'bitdepth': (8, 8, 8, 8), + 'signed': (False, False, False, False), + 'xyrsiz': [(1, 1, 2, 2), (1, 1, 2, 2)]} + self.verifySizSegment(c.segment[1], + glymur.codestream.SIZsegment(**kwargs)) # COD: Coding style default self.assertFalse(c.segment[2].scod & 2) # no sop @@ -2121,18 +1328,8 @@ class TestSuiteDump(unittest.TestCase): self.assertEqual(c.segment[2].spcod[3], 0) # mct self.assertEqual(c.segment[2].spcod[4], 6) # level self.assertEqual(tuple(c.segment[2].code_block_size), (32, 32)) - # Selective arithmetic coding bypass - self.assertTrue(c.segment[2].spcod[7] & 0x01) - # Reset context probabilities - self.assertFalse(c.segment[2].spcod[7] & 0x02) - # Termination on each coding pass - self.assertTrue(c.segment[2].spcod[7] & 0x04) - # Vertically causal context - self.assertFalse(c.segment[2].spcod[7] & 0x08) - # Predictable termination - self.assertFalse(c.segment[2].spcod[7] & 0x0010) - # Segmentation symbols - self.assertFalse(c.segment[2].spcod[7] & 0x0020) + self.verify_codeblock_style(c.segment[2].spcod[7], + [True, False, True, False, False, False]) self.assertEqual(c.segment[2].spcod[8], glymur.core.WAVELET_XFORM_9X7_IRREVERSIBLE) self.assertEqual(len(c.segment[2].spcod), 9) @@ -2141,18 +1338,8 @@ class TestSuiteDump(unittest.TestCase): self.assertEqual(c.segment[3].ccoc, 1) self.assertEqual(c.segment[3].spcoc[0], 3) # level self.assertEqual(tuple(c.segment[3].code_block_size), (32, 32)) - # Selective arithmetic coding bypass - self.assertTrue(c.segment[3].spcoc[3] & 0x01) - # Reset context probabilities - self.assertFalse(c.segment[3].spcoc[3] & 0x02) - # Termination on each coding pass - self.assertTrue(c.segment[3].spcoc[3] & 0x04) - # Vertically causal context - self.assertFalse(c.segment[3].spcoc[3] & 0x08) - # Predictable termination - self.assertFalse(c.segment[3].spcoc[3] & 0x0010) - # Segmentation symbols - self.assertFalse(c.segment[3].spcoc[3] & 0x0020) + self.verify_codeblock_style(c.segment[3].spcoc[3], + [True, False, True, False, False, False]) self.assertEqual(c.segment[3].spcoc[4], glymur.core.WAVELET_XFORM_9X7_IRREVERSIBLE) @@ -2160,18 +1347,8 @@ class TestSuiteDump(unittest.TestCase): self.assertEqual(c.segment[4].ccoc, 3) self.assertEqual(c.segment[4].spcoc[0], 6) # level self.assertEqual(tuple(c.segment[4].code_block_size), (32, 32)) - # Selective arithmetic coding bypass - self.assertTrue(c.segment[4].spcoc[3] & 0x01) - # Reset context probabilities - self.assertFalse(c.segment[4].spcoc[3] & 0x02) - # Termination on each coding pass - self.assertTrue(c.segment[4].spcoc[3] & 0x04) - # Vertically causal context - self.assertFalse(c.segment[4].spcoc[3] & 0x08) - # Predictable termination - self.assertFalse(c.segment[4].spcoc[3] & 0x0010) - # Segmentation symbols - self.assertFalse(c.segment[4].spcoc[3] & 0x0020) + self.verify_codeblock_style(c.segment[4].spcoc[3], + [True, False, True, False, False, False]) self.assertEqual(c.segment[4].spcoc[4], glymur.core.WAVELET_XFORM_5X3_REVERSIBLE) @@ -2207,12 +1384,9 @@ class TestSuiteDump(unittest.TestCase): [8, 9, 9, 10, 9, 9, 10, 9, 9, 10, 9, 9, 10, 9, 9, 10, 9, 9, 10]) - # COM: comment - # Registration - self.assertEqual(c.segment[8].rcme, glymur.core.RCME_ISO_8859_1) - # Comment value - self.assertEqual(c.segment[8].ccme.decode('latin-1'), - "Creator: AV-J2K (c) 2000,2001 Algo Vision") + pargs = (RCME_ISO_8859_1, + "Creator: AV-J2K (c) 2000,2001 Algo Vision".encode()) + self.verifyCMEsegment(c.segment[8], CMEsegment(*pargs)) # PPM: packed packet headers, main header self.assertEqual(c.segment[9].marker_id, 'PPM') @@ -2223,11 +1397,7 @@ class TestSuiteDump(unittest.TestCase): self.assertEqual(c.segment[10].ttlm, (0,)) self.assertEqual(c.segment[10].ptlm, (1366780,)) - # SOT: start of tile part - self.assertEqual(c.segment[11].isot, 0) - self.assertEqual(c.segment[11].psot, 1366780) - self.assertEqual(c.segment[11].tpsot, 0) - self.assertEqual(c.segment[11].tnsot, 1) + self.verifySOTsegment(c.segment[11], SOTsegment(0, 1366780, 0, 1)) # SOD: start of data self.assertEqual(c.segment[12].marker_id, 'SOD') @@ -2239,25 +1409,12 @@ class TestSuiteDump(unittest.TestCase): jfile = opj_data_file('input/conformance/p1_04.j2k') c = Jp2k(jfile).get_codestream(header_only=False) - # SIZ: Image and tile size - # Profile: "1" means profile 1 - self.assertEqual(c.segment[1].rsiz, 2) - # Reference grid size - self.assertEqual(c.segment[1].xsiz, 1024) - self.assertEqual(c.segment[1].ysiz, 1024) - # Reference grid offset - self.assertEqual((c.segment[1].xosiz, c.segment[1].yosiz), (0, 0)) - # Tile size - self.assertEqual((c.segment[1].xtsiz, c.segment[1].ytsiz), (128, 128)) - # Tile offset - self.assertEqual((c.segment[1].xtosiz, c.segment[1].ytosiz), (0, 0)) - # bitdepth - self.assertEqual(c.segment[1].bitdepth, (12,)) - # signed - self.assertEqual(c.segment[1].signed, (False,)) - # subsampling - self.assertEqual(list(zip(c.segment[1].xrsiz, c.segment[1].yrsiz)), - [(1, 1)]) + kwargs = {'rsiz': 2, 'xysiz': (1024, 1024), 'xyosiz': (0, 0), + 'xytsiz': (128, 128), 'xytosiz': (0, 0), 'bitdepth': (12,), + 'signed': (False,), + 'xyrsiz': [(1,), (1,)]} + self.verifySizSegment(c.segment[1], + glymur.codestream.SIZsegment(**kwargs)) # COD: Coding style default self.assertFalse(c.segment[2].scod & 2) # no sop @@ -2267,18 +1424,8 @@ class TestSuiteDump(unittest.TestCase): self.assertEqual(c.segment[2].spcod[3], 0) # mct self.assertEqual(c.segment[2].spcod[4], 3) # level self.assertEqual(tuple(c.segment[2].code_block_size), (64, 64)) - # Selective arithmetic coding bypass - self.assertFalse(c.segment[2].spcod[7] & 0x01) - # Reset context probabilities - self.assertFalse(c.segment[2].spcod[7] & 0x02) - # Termination on each coding pass - self.assertFalse(c.segment[2].spcod[7] & 0x04) - # Vertically causal context - self.assertFalse(c.segment[2].spcod[7] & 0x08) - # Predictable termination - self.assertFalse(c.segment[2].spcod[7] & 0x0010) - # Segmentation symbols - self.assertFalse(c.segment[2].spcod[7] & 0x0020) + self.verify_codeblock_style(c.segment[2].spcod[7], + [False, False, False, False, False, False]) self.assertEqual(c.segment[2].spcod[8], glymur.core.WAVELET_XFORM_9X7_IRREVERSIBLE) self.assertEqual(len(c.segment[2].spcod), 9) @@ -2304,27 +1451,15 @@ class TestSuiteDump(unittest.TestCase): 554, 546, 542, 635, 826, 667, 617, 606, 813, 586, 641, 654, 669, 623)) - # COM: comment - # Registration - self.assertEqual(c.segment[5].rcme, glymur.core.RCME_ISO_8859_1) - # Comment value - self.assertEqual(c.segment[5].ccme.decode('latin-1'), - "Created by Aware, Inc.") + pargs = (RCME_ISO_8859_1, "Created by Aware, Inc.".encode()) + self.verifyCMEsegment(c.segment[5], CMEsegment(*pargs)) - # SOT: start of tile part - self.assertEqual(c.segment[6].isot, 0) - self.assertEqual(c.segment[6].psot, 350) - self.assertEqual(c.segment[6].tpsot, 0) - self.assertEqual(c.segment[6].tnsot, 1) + self.verifySOTsegment(c.segment[6], SOTsegment(0, 350, 0, 1)) # SOD: start of data self.assertEqual(c.segment[7].marker_id, 'SOD') - # SOT: start of tile part - self.assertEqual(c.segment[8].isot, 1) - self.assertEqual(c.segment[8].psot, 356) - self.assertEqual(c.segment[8].tpsot, 0) - self.assertEqual(c.segment[8].tnsot, 1) + self.verifySOTsegment(c.segment[8], SOTsegment(1, 356, 0, 1)) # QCD: Quantization default # quantization type @@ -2339,11 +1474,7 @@ class TestSuiteDump(unittest.TestCase): # SOD: start of data self.assertEqual(c.segment[10].marker_id, 'SOD') - # SOT: start of tile part - self.assertEqual(c.segment[11].isot, 2) - self.assertEqual(c.segment[11].psot, 402) - self.assertEqual(c.segment[11].tpsot, 0) - self.assertEqual(c.segment[11].tnsot, 1) + self.verifySOTsegment(c.segment[11], SOTsegment(2, 402, 0, 1)) # and so on @@ -2366,25 +1497,13 @@ class TestSuiteDump(unittest.TestCase): jfile = opj_data_file('input/conformance/p1_05.j2k') c = Jp2k(jfile).get_codestream(header_only=False) - # SIZ: Image and tile size - # Profile: "1" means profile 1 - self.assertEqual(c.segment[1].rsiz, 2) - # Reference grid size - self.assertEqual(c.segment[1].xsiz, 529) - self.assertEqual(c.segment[1].ysiz, 524) - # Reference grid offset - self.assertEqual((c.segment[1].xosiz, c.segment[1].yosiz), (17, 12)) - # Tile size - self.assertEqual((c.segment[1].xtsiz, c.segment[1].ytsiz), (37, 37)) - # Tile offset - self.assertEqual((c.segment[1].xtosiz, c.segment[1].ytosiz), (8, 2)) - # bitdepth - self.assertEqual(c.segment[1].bitdepth, (8, 8, 8)) - # signed - self.assertEqual(c.segment[1].signed, (False, False, False)) - # subsampling - self.assertEqual(list(zip(c.segment[1].xrsiz, c.segment[1].yrsiz)), - [(1, 1)] * 3) + kwargs = {'rsiz': 2, 'xysiz': (529, 524), 'xyosiz': (17, 12), + 'xytsiz': (37, 37), 'xytosiz': (8, 2), + 'bitdepth': (8, 8, 8), + 'signed': (False, False, False), + 'xyrsiz': [(1, 1, 1), (1, 1, 1)]} + self.verifySizSegment(c.segment[1], + glymur.codestream.SIZsegment(**kwargs)) # COD: Coding style default self.assertTrue(c.segment[2].scod & 2) # sop @@ -2394,18 +1513,8 @@ class TestSuiteDump(unittest.TestCase): self.assertEqual(c.segment[2].spcod[3], 1) # mct self.assertEqual(c.segment[2].spcod[4], 7) # level self.assertEqual(tuple(c.segment[2].code_block_size), (64, 8)) # cblk - # Selective arithmetic coding bypass - self.assertTrue(c.segment[2].spcod[7] & 0x01) - # Reset context probabilities - self.assertFalse(c.segment[2].spcod[7] & 0x02) - # Termination on each coding pass - self.assertFalse(c.segment[2].spcod[7] & 0x04) - # Vertically causal context - self.assertTrue(c.segment[2].spcod[7] & 0x08) - # Predictable termination - self.assertTrue(c.segment[2].spcod[7] & 0x0010) - # Segmentation symbols - self.assertFalse(c.segment[2].spcod[7] & 0x0020) + self.verify_codeblock_style(c.segment[2].spcod[7], + [True, False, False, True, True, False]) self.assertEqual(c.segment[2].spcod[8], glymur.core.WAVELET_XFORM_9X7_IRREVERSIBLE) self.assertEqual(c.segment[2].precinct_size, [(16, 16)] * 8) @@ -2420,22 +1529,15 @@ class TestSuiteDump(unittest.TestCase): [17, 17, 17, 17, 16, 16, 16, 15, 15, 15, 14, 14, 14, 13, 13, 13, 11, 11, 11, 11, 11, 11]) - # COM: comment - # Registration - self.assertEqual(c.segment[4].rcme, glymur.core.RCME_ISO_8859_1) - # Comment value - self.assertEqual(c.segment[4].ccme.decode('latin-1'), - "Creator: AV-J2K (c) 2000,2001 Algo Vision") + pargs = (RCME_ISO_8859_1, + "Creator: AV-J2K (c) 2000,2001 Algo Vision".encode()) + self.verifyCMEsegment(c.segment[4], CMEsegment(*pargs)) # 225 consecutive PPM segments. zppm = [x.zppm for x in c.segment[5:230]] self.assertEqual(zppm, list(range(225))) - # SOT: start of tile part - self.assertEqual(c.segment[230].isot, 0) - self.assertEqual(c.segment[230].psot, 580) - self.assertEqual(c.segment[230].tpsot, 0) - self.assertEqual(c.segment[230].tnsot, 1) + self.verifySOTsegment(c.segment[230], SOTsegment(0, 580, 0, 1)) # 225 total SOT segments isot = [x.isot for x in c.segment if x.marker_id == 'SOT'] @@ -2454,25 +1556,12 @@ class TestSuiteDump(unittest.TestCase): jfile = opj_data_file('input/conformance/p1_06.j2k') c = Jp2k(jfile).get_codestream(header_only=False) - # SIZ: Image and tile size - # Profile: "1" means profile 1 - self.assertEqual(c.segment[1].rsiz, 2) - # Reference grid size - self.assertEqual(c.segment[1].xsiz, 12) - self.assertEqual(c.segment[1].ysiz, 12) - # Reference grid offset - self.assertEqual((c.segment[1].xosiz, c.segment[1].yosiz), (0, 0)) - # Tile size - self.assertEqual((c.segment[1].xtsiz, c.segment[1].ytsiz), (3, 3)) - # Tile offset - self.assertEqual((c.segment[1].xtosiz, c.segment[1].ytosiz), (0, 0)) - # bitdepth - self.assertEqual(c.segment[1].bitdepth, (8, 8, 8)) - # signed - self.assertEqual(c.segment[1].signed, (False, False, False)) - # subsampling - self.assertEqual(list(zip(c.segment[1].xrsiz, c.segment[1].yrsiz)), - [(1, 1)] * 3) + kwargs = {'rsiz': 2, 'xysiz': (12, 12), 'xyosiz': (0, 0), + 'xytsiz': (3, 3), 'xytosiz': (0, 0), 'bitdepth': (8, 8, 8), + 'signed': (False, False, False), + 'xyrsiz': [(1, 1, 1), (1, 1, 1)]} + self.verifySizSegment(c.segment[1], + glymur.codestream.SIZsegment(**kwargs)) # COD: Coding style default self.assertTrue(c.segment[2].scod & 2) # sop @@ -2482,18 +1571,8 @@ class TestSuiteDump(unittest.TestCase): self.assertEqual(c.segment[2].spcod[3], 1) # mct self.assertEqual(c.segment[2].spcod[4], 4) # level self.assertEqual(tuple(c.segment[2].code_block_size), (32, 64)) - # Selective arithmetic coding bypass - self.assertFalse(c.segment[2].spcod[7] & 0x01) - # Reset context probabilities - self.assertFalse(c.segment[2].spcod[7] & 0x02) - # Termination on each coding pass - self.assertFalse(c.segment[2].spcod[7] & 0x04) - # Vertically causal context - self.assertTrue(c.segment[2].spcod[7] & 0x08) - # Predictable termination - self.assertFalse(c.segment[2].spcod[7] & 0x0010) - # Segmentation symbols - self.assertTrue(c.segment[2].spcod[7] & 0x0020) + self.verify_codeblock_style(c.segment[2].spcod[7], + [False, False, False, True, False, True]) self.assertEqual(c.segment[2].spcod[8], glymur.core.WAVELET_XFORM_9X7_IRREVERSIBLE) self.assertEqual(len(c.segment[2].spcod), 9) @@ -2509,18 +1588,11 @@ class TestSuiteDump(unittest.TestCase): [14, 14, 14, 14, 13, 13, 13, 11, 11, 11, 11, 11, 11]) - # COM: comment - # Registration - self.assertEqual(c.segment[4].rcme, glymur.core.RCME_ISO_8859_1) - # Comment value - self.assertEqual(c.segment[4].ccme.decode('latin-1'), - "Creator: AV-J2K (c) 2000,2001 Algo Vision") + pargs = (RCME_ISO_8859_1, + "Creator: AV-J2K (c) 2000,2001 Algo Vision".encode()) + self.verifyCMEsegment(c.segment[4], CMEsegment(*pargs)) - # SOT: start of tile part - self.assertEqual(c.segment[5].isot, 0) - self.assertEqual(c.segment[5].psot, 349) - self.assertEqual(c.segment[5].tpsot, 0) - self.assertEqual(c.segment[5].tnsot, 1) + self.verifySOTsegment(c.segment[5], SOTsegment(0, 349, 0, 1)) # PPT: packed packet headers, tile-part header self.assertEqual(c.segment[6].marker_id, 'PPT') @@ -2547,25 +1619,12 @@ class TestSuiteDump(unittest.TestCase): jfile = opj_data_file('input/conformance/p1_07.j2k') c = Jp2k(jfile).get_codestream(header_only=False) - # SIZ: Image and tile size - # Profile: "1" means profile 1 - self.assertEqual(c.segment[1].rsiz, 2) - # Reference grid size - self.assertEqual(c.segment[1].xsiz, 12) - self.assertEqual(c.segment[1].ysiz, 12) - # Reference grid offset - self.assertEqual((c.segment[1].xosiz, c.segment[1].yosiz), (4, 0)) - # Tile size - self.assertEqual((c.segment[1].xtsiz, c.segment[1].ytsiz), (12, 12)) - # Tile offset - self.assertEqual((c.segment[1].xtosiz, c.segment[1].ytosiz), (4, 0)) - # bitdepth - self.assertEqual(c.segment[1].bitdepth, (8, 8)) - # signed - self.assertEqual(c.segment[1].signed, (False, False)) - # subsampling - self.assertEqual(list(zip(c.segment[1].xrsiz, c.segment[1].yrsiz)), - [(4, 1), (1, 1)]) + kwargs = {'rsiz': 2, 'xysiz': (12, 12), 'xyosiz': (4, 0), + 'xytsiz': (12, 12), 'xytosiz': (4, 0), 'bitdepth': (8, 8), + 'signed': (False, False), + 'xyrsiz': [(4, 1), (1, 1)]} + self.verifySizSegment(c.segment[1], + glymur.codestream.SIZsegment(**kwargs)) # COD: Coding style default self.assertTrue(c.segment[2].scod & 2) # sop @@ -2575,18 +1634,8 @@ class TestSuiteDump(unittest.TestCase): self.assertEqual(c.segment[2].spcod[3], 0) # mct self.assertEqual(c.segment[2].spcod[4], 1) # level self.assertEqual(tuple(c.segment[2].code_block_size), (64, 64)) - # Selective arithmetic coding bypass - self.assertFalse(c.segment[2].spcod[7] & 0x01) - # Reset context probabilities - self.assertFalse(c.segment[2].spcod[7] & 0x02) - # Termination on each coding pass - self.assertFalse(c.segment[2].spcod[7] & 0x04) - # Vertically causal context - self.assertFalse(c.segment[2].spcod[7] & 0x08) - # Predictable termination - self.assertFalse(c.segment[2].spcod[7] & 0x0010) - # Segmentation symbols - self.assertFalse(c.segment[2].spcod[7] & 0x0020) + self.verify_codeblock_style(c.segment[2].spcod[7], + [False, False, False, False, False, False]) self.assertEqual(c.segment[2].spcod[8], glymur.core.WAVELET_XFORM_5X3_REVERSIBLE) self.assertEqual(c.segment[2].precinct_size, [(1, 1), (2, 2)]) @@ -2595,18 +1644,8 @@ class TestSuiteDump(unittest.TestCase): self.assertEqual(c.segment[3].ccoc, 1) self.assertEqual(c.segment[3].spcoc[0], 1) # level self.assertEqual(tuple(c.segment[3].code_block_size), (64, 64)) - # Selective arithmetic coding bypass - self.assertFalse(c.segment[3].spcoc[3] & 0x01) - # Reset context probabilities - self.assertFalse(c.segment[3].spcoc[3] & 0x02) - # Termination on each coding pass - self.assertFalse(c.segment[3].spcoc[3] & 0x04) - # Vertically causal context - self.assertFalse(c.segment[3].spcoc[3] & 0x08) - # Predictable termination - self.assertFalse(c.segment[3].spcoc[3] & 0x0010) - # Segmentation symbols - self.assertFalse(c.segment[3].spcoc[3] & 0x0020) + self.verify_codeblock_style(c.segment[3].spcoc[3], + [False, False, False, False, False, False]) self.assertEqual(c.segment[3].spcoc[4], glymur.core.WAVELET_XFORM_5X3_REVERSIBLE) self.assertEqual(c.segment[3].precinct_size, [(2, 2), (4, 4)]) @@ -2618,472 +1657,30 @@ class TestSuiteDump(unittest.TestCase): self.assertEqual(c.segment[4].mantissa, [0] * 4) self.assertEqual(c.segment[4].exponent, [8, 9, 9, 10]) - # COM: comment - # Registration - self.assertEqual(c.segment[5].rcme, glymur.core.RCME_ISO_8859_1) - # Comment value - self.assertEqual(c.segment[5].ccme.decode('latin-1'), - "Creator: AV-J2K (c) 2000,2001 Algo Vision") + pargs = (RCME_ISO_8859_1, + "Creator: AV-J2K (c) 2000,2001 Algo Vision".encode()) + self.verifyCMEsegment(c.segment[5], CMEsegment(*pargs)) - # SOT: start of tile part - self.assertEqual(c.segment[6].isot, 0) - self.assertEqual(c.segment[6].psot, 434) - self.assertEqual(c.segment[6].tpsot, 0) - self.assertEqual(c.segment[6].tnsot, 1) + self.verifySOTsegment(c.segment[6], SOTsegment(0, 434, 0, 1)) # scads of SOP, EPH segments # EOC: end of codestream self.assertEqual(c.segment[-1].marker_id, 'EOC') - def test_NR_file1_dump(self): - jfile = opj_data_file('input/conformance/file1.jp2') - with warnings.catch_warnings(): - # Bad compatibility list item. - warnings.simplefilter("ignore") - jp2 = Jp2k(jfile) - - ids = [box.box_id for box in jp2.box] - self.assertEqual(ids, ['jP ', 'ftyp', 'xml ', 'jp2h', 'xml ', - 'jp2c']) - - ids = [box.box_id for box in jp2.box[3].box] - self.assertEqual(ids, ['ihdr', 'colr']) - - # Signature box. Check for corruption. - self.assertEqual(jp2.box[0].signature, (13, 10, 135, 10)) - - # File type box. - self.assertEqual(jp2.box[1].brand, 'jp2 ') - self.assertEqual(jp2.box[1].minor_version, 0) - self.assertEqual(jp2.box[1].compatibility_list[1], 'jp2 ') - - # XML box - tags = [x.tag for x in jp2.box[2].xml.getroot()] - self.assertEqual(tags, - ['{http://www.jpeg.org/jpx/1.0/xml}' - + 'GENERAL_CREATION_INFO']) - - # Jp2 Header - # Image header - self.assertEqual(jp2.box[3].box[0].height, 512) - self.assertEqual(jp2.box[3].box[0].width, 768) - self.assertEqual(jp2.box[3].box[0].num_components, 3) - self.assertEqual(jp2.box[3].box[0].bits_per_component, 8) - self.assertEqual(jp2.box[3].box[0].signed, False) - self.assertEqual(jp2.box[3].box[0].compression, 7) # wavelet - self.assertEqual(jp2.box[3].box[0].colorspace_unknown, False) - self.assertEqual(jp2.box[3].box[0].ip_provided, False) - - # Jp2 Header - # Colour specification - self.assertEqual(jp2.box[3].box[1].method, - glymur.core.ENUMERATED_COLORSPACE) - self.assertEqual(jp2.box[3].box[1].precedence, 0) - self.assertEqual(jp2.box[3].box[1].approximation, 1) # JPX exact ?? - self.assertEqual(jp2.box[3].box[1].colorspace, glymur.core.SRGB) - - # XML box - tags = [x.tag for x in jp2.box[4].xml.getroot()] - self.assertEqual(tags, ['{http://www.jpeg.org/jpx/1.0/xml}CAPTION', - '{http://www.jpeg.org/jpx/1.0/xml}LOCATION', - '{http://www.jpeg.org/jpx/1.0/xml}EVENT']) - - def test_NR_file2_dump(self): - jfile = opj_data_file('input/conformance/file2.jp2') - jp2 = Jp2k(jfile) - - ids = [box.box_id for box in jp2.box] - self.assertEqual(ids, ['jP ', 'ftyp', 'jp2h', 'jp2c']) - - ids = [box.box_id for box in jp2.box[2].box] - self.assertEqual(ids, ['ihdr', 'colr', 'cdef']) - - # Signature box. Check for corruption. - self.assertEqual(jp2.box[0].signature, (13, 10, 135, 10)) - - # File type box. - self.assertEqual(jp2.box[1].brand, 'jp2 ') - self.assertEqual(jp2.box[1].minor_version, 0) - self.assertEqual(jp2.box[1].compatibility_list[1], 'jp2 ') - - # Jp2 Header - # Image header - self.assertEqual(jp2.box[2].box[0].height, 640) - self.assertEqual(jp2.box[2].box[0].width, 480) - self.assertEqual(jp2.box[2].box[0].num_components, 3) - self.assertEqual(jp2.box[2].box[0].bits_per_component, 8) - self.assertEqual(jp2.box[2].box[0].signed, False) - self.assertEqual(jp2.box[2].box[0].compression, 7) # wavelet - self.assertEqual(jp2.box[2].box[0].colorspace_unknown, False) - self.assertEqual(jp2.box[2].box[0].ip_provided, False) - - # Jp2 Header - # Colour specification - self.assertEqual(jp2.box[2].box[1].method, - glymur.core.ENUMERATED_COLORSPACE) - self.assertEqual(jp2.box[2].box[1].precedence, 0) - self.assertEqual(jp2.box[2].box[1].approximation, 1) # JPX exact?? - self.assertEqual(jp2.box[2].box[1].colorspace, glymur.core.YCC) - - # Jp2 Header - # Channel Definition - self.assertEqual(jp2.box[2].box[2].index, (0, 1, 2)) - self.assertEqual(jp2.box[2].box[2].channel_type, (0, 0, 0)) # color - self.assertEqual(jp2.box[2].box[2].association, (3, 2, 1)) # reverse - - def test_NR_file3_dump(self): - # Three 8-bit components in the sRGB-YCC colourspace, with the Cb and - # Cr components being subsampled 2x in both the horizontal and - # vertical directions. The components are stored in the standard - # order. - jfile = opj_data_file('input/conformance/file3.jp2') - jp2 = Jp2k(jfile) - - ids = [box.box_id for box in jp2.box] - self.assertEqual(ids, ['jP ', 'ftyp', 'jp2h', 'jp2c']) - - ids = [box.box_id for box in jp2.box[2].box] - self.assertEqual(ids, ['ihdr', 'colr']) - - # Signature box. Check for corruption. - self.assertEqual(jp2.box[0].signature, (13, 10, 135, 10)) - - # File type box. - self.assertEqual(jp2.box[1].brand, 'jp2 ') - self.assertEqual(jp2.box[1].minor_version, 0) - self.assertEqual(jp2.box[1].compatibility_list[1], 'jp2 ') - - # Jp2 Header - # Image header - self.assertEqual(jp2.box[2].box[0].height, 640) - self.assertEqual(jp2.box[2].box[0].width, 480) - self.assertEqual(jp2.box[2].box[0].num_components, 3) - self.assertEqual(jp2.box[2].box[0].bits_per_component, 8) - self.assertEqual(jp2.box[2].box[0].signed, False) - self.assertEqual(jp2.box[2].box[0].compression, 7) # wavelet - self.assertEqual(jp2.box[2].box[0].colorspace_unknown, False) - self.assertEqual(jp2.box[2].box[0].ip_provided, False) - - # Jp2 Header - # Colour specification - self.assertEqual(jp2.box[2].box[1].method, - glymur.core.ENUMERATED_COLORSPACE) - self.assertEqual(jp2.box[2].box[1].precedence, 0) - self.assertEqual(jp2.box[2].box[1].approximation, 1) # JPX exact - self.assertEqual(jp2.box[2].box[1].colorspace, glymur.core.YCC) - - # sub-sampling - codestream = jp2.get_codestream() - self.assertEqual(codestream.segment[1].xrsiz[0], 1) - self.assertEqual(codestream.segment[1].yrsiz[0], 1) - self.assertEqual(codestream.segment[1].xrsiz[1], 2) - self.assertEqual(codestream.segment[1].yrsiz[1], 2) - self.assertEqual(codestream.segment[1].xrsiz[2], 2) - self.assertEqual(codestream.segment[1].yrsiz[2], 2) - - def test_NR_file4_dump(self): - # One 8-bit component in the sRGB-grey colourspace. - jfile = opj_data_file('input/conformance/file4.jp2') - jp2 = Jp2k(jfile) - - ids = [box.box_id for box in jp2.box] - self.assertEqual(ids, ['jP ', 'ftyp', 'jp2h', 'jp2c']) - - ids = [box.box_id for box in jp2.box[2].box] - self.assertEqual(ids, ['ihdr', 'colr']) - - # Signature box. Check for corruption. - self.assertEqual(jp2.box[0].signature, (13, 10, 135, 10)) - - # File type box. - self.assertEqual(jp2.box[1].brand, 'jp2 ') - self.assertEqual(jp2.box[1].minor_version, 0) - self.assertEqual(jp2.box[1].compatibility_list[1], 'jp2 ') - - # Jp2 Header - # Image header - self.assertEqual(jp2.box[2].box[0].height, 512) - self.assertEqual(jp2.box[2].box[0].width, 768) - self.assertEqual(jp2.box[2].box[0].num_components, 1) - self.assertEqual(jp2.box[2].box[0].bits_per_component, 8) - self.assertEqual(jp2.box[2].box[0].signed, False) - self.assertEqual(jp2.box[2].box[0].compression, 7) # wavelet - self.assertEqual(jp2.box[2].box[0].colorspace_unknown, False) - self.assertEqual(jp2.box[2].box[0].ip_provided, False) - - # Jp2 Header - # Colour specification - self.assertEqual(jp2.box[2].box[1].method, - glymur.core.ENUMERATED_COLORSPACE) - self.assertEqual(jp2.box[2].box[1].precedence, 0) - self.assertEqual(jp2.box[2].box[1].approximation, 1) # JPX exact? - self.assertEqual(jp2.box[2].box[1].colorspace, glymur.core.GREYSCALE) - - def test_NR_file5_dump(self): - # Three 8-bit components in the ROMM-RGB colourspace, encapsulated in a - # JPX file. The components have been transformed using - # the RCT. The colourspace is specified using both a Restricted ICC - # profile and using the JPX-defined enumerated code for the ROMM-RGB - # colourspace. - jfile = opj_data_file('input/conformance/file5.jp2') - with warnings.catch_warnings(): - # There's a warning for an unknown compatibility entry. - # Ignore it here. - warnings.simplefilter("ignore") - jp2 = Jp2k(jfile) - - ids = [box.box_id for box in jp2.box] - self.assertEqual(ids, ['jP ', 'ftyp', 'rreq', 'jp2h', 'jp2c']) - - ids = [box.box_id for box in jp2.box[3].box] - self.assertEqual(ids, ['ihdr', 'colr', 'colr']) - - # Signature box. Check for corruption. - self.assertEqual(jp2.box[0].signature, (13, 10, 135, 10)) - - # File type box. - self.assertEqual(jp2.box[1].brand, 'jpx ') - self.assertEqual(jp2.box[1].minor_version, 0) - self.assertEqual(jp2.box[1].compatibility_list[1], 'jp2 ') - - # Jp2 Header - # Image header - self.assertEqual(jp2.box[3].box[0].height, 512) - self.assertEqual(jp2.box[3].box[0].width, 768) - self.assertEqual(jp2.box[3].box[0].num_components, 3) - self.assertEqual(jp2.box[3].box[0].signed, False) - self.assertEqual(jp2.box[3].box[0].compression, 7) # wavelet - self.assertEqual(jp2.box[3].box[0].colorspace_unknown, False) - self.assertEqual(jp2.box[3].box[0].ip_provided, False) - - # Jp2 Header - # Colour specification - self.assertEqual(jp2.box[3].box[1].method, - glymur.core.RESTRICTED_ICC_PROFILE) # enumerated - self.assertEqual(jp2.box[3].box[1].precedence, 0) - self.assertEqual(jp2.box[3].box[1].approximation, 1) # JPX exact - self.assertEqual(jp2.box[3].box[1].icc_profile['Size'], 546) - self.assertIsNone(jp2.box[3].box[1].colorspace) - - def test_NR_file6_dump(self): - jfile = opj_data_file('input/conformance/file6.jp2') - jp2 = Jp2k(jfile) - - ids = [box.box_id for box in jp2.box] - self.assertEqual(ids, ['jP ', 'ftyp', 'jp2h', 'jp2c']) - - ids = [box.box_id for box in jp2.box[2].box] - self.assertEqual(ids, ['ihdr', 'colr']) - - # Signature box. Check for corruption. - self.assertEqual(jp2.box[0].signature, (13, 10, 135, 10)) - - # File type box. - self.assertEqual(jp2.box[1].brand, 'jp2 ') - self.assertEqual(jp2.box[1].minor_version, 0) - self.assertEqual(jp2.box[1].compatibility_list[1], 'jp2 ') - - # Jp2 Header - # Image header - self.assertEqual(jp2.box[2].box[0].height, 512) - self.assertEqual(jp2.box[2].box[0].width, 768) - self.assertEqual(jp2.box[2].box[0].num_components, 1) - self.assertEqual(jp2.box[2].box[0].bits_per_component, 12) - self.assertEqual(jp2.box[2].box[0].signed, False) - self.assertEqual(jp2.box[2].box[0].compression, 7) # wavelet - self.assertEqual(jp2.box[2].box[0].colorspace_unknown, False) - self.assertEqual(jp2.box[2].box[0].ip_provided, False) - - # Jp2 Header - # Colour specification - self.assertEqual(jp2.box[2].box[1].method, - glymur.core.ENUMERATED_COLORSPACE) - self.assertEqual(jp2.box[2].box[1].precedence, 0) - self.assertEqual(jp2.box[2].box[1].approximation, 1) # JPX exact - self.assertIsNone(jp2.box[2].box[1].icc_profile) - self.assertEqual(jp2.box[2].box[1].colorspace, - glymur.core.GREYSCALE) - - def test_NR_file7_dump(self): - # Three 16-bit components in the e-sRGB colourspace, encapsulated in a - # JP2 compatible JPX file. The components have been transformed using - # the RCT. The colourspace is specified using both a Restricted ICC - # profile and using the JPX-defined enumerated code for the e-sRGB - # colourspace. - jfile = opj_data_file('input/conformance/file7.jp2') - jp2 = Jp2k(jfile) - - ids = [box.box_id for box in jp2.box] - self.assertEqual(ids, ['jP ', 'ftyp', 'rreq', 'jp2h', 'jp2c']) - - ids = [box.box_id for box in jp2.box[3].box] - self.assertEqual(ids, ['ihdr', 'colr', 'colr']) - - # Signature box. Check for corruption. - self.assertEqual(jp2.box[0].signature, (13, 10, 135, 10)) - - # File type box. - self.assertEqual(jp2.box[1].brand, 'jpx ') - self.assertEqual(jp2.box[1].compatibility_list[1], 'jp2 ') - - # Jp2 Header - # Image header - self.assertEqual(jp2.box[3].box[0].height, 640) - self.assertEqual(jp2.box[3].box[0].width, 480) - self.assertEqual(jp2.box[3].box[0].num_components, 3) - self.assertEqual(jp2.box[3].box[0].bits_per_component, 16) - self.assertEqual(jp2.box[3].box[0].signed, False) - self.assertEqual(jp2.box[3].box[0].compression, 7) # wavelet - self.assertEqual(jp2.box[3].box[0].colorspace_unknown, False) - self.assertEqual(jp2.box[3].box[0].ip_provided, False) - - # Jp2 Header - # Colour specification - self.assertEqual(jp2.box[3].box[1].method, - glymur.core.RESTRICTED_ICC_PROFILE) - self.assertEqual(jp2.box[3].box[1].precedence, 0) - self.assertEqual(jp2.box[3].box[1].approximation, 1) - self.assertEqual(jp2.box[3].box[1].icc_profile['Size'], 13332) - self.assertIsNone(jp2.box[3].box[1].colorspace) - - def test_NR_file8_dump(self): - # One 8-bit component in a gamma 1.8 space. The colourspace is - # specified using a Restricted ICC profile. - jfile = opj_data_file('input/conformance/file8.jp2') - jp2 = Jp2k(jfile) - - ids = [box.box_id for box in jp2.box] - self.assertEqual(ids, ['jP ', 'ftyp', 'jp2h', 'xml ', 'jp2c', - 'xml ']) - - ids = [box.box_id for box in jp2.box[2].box] - self.assertEqual(ids, ['ihdr', 'colr']) - - # Signature box. Check for corruption. - self.assertEqual(jp2.box[0].signature, (13, 10, 135, 10)) - - # File type box. - self.assertEqual(jp2.box[1].brand, 'jp2 ') - self.assertEqual(jp2.box[1].compatibility_list[1], 'jp2 ') - self.assertEqual(jp2.box[1].minor_version, 0) - - # Jp2 Header - # Image header - self.assertEqual(jp2.box[2].box[0].height, 400) - self.assertEqual(jp2.box[2].box[0].width, 700) - self.assertEqual(jp2.box[2].box[0].num_components, 1) - self.assertEqual(jp2.box[2].box[0].bits_per_component, 8) - self.assertEqual(jp2.box[2].box[0].signed, False) - self.assertEqual(jp2.box[2].box[0].compression, 7) # wavelet - self.assertEqual(jp2.box[2].box[0].colorspace_unknown, False) - self.assertEqual(jp2.box[2].box[0].ip_provided, False) - - # Jp2 Header - # Colour specification - self.assertEqual(jp2.box[2].box[1].method, - glymur.core.RESTRICTED_ICC_PROFILE) # enumerated - self.assertEqual(jp2.box[2].box[1].precedence, 0) - self.assertEqual(jp2.box[2].box[1].approximation, 1) # JPX exact - self.assertEqual(jp2.box[2].box[1].icc_profile['Size'], 414) - self.assertIsNone(jp2.box[2].box[1].colorspace) - - # XML box - tags = [x.tag for x in jp2.box[3].xml.getroot()] - self.assertEqual(tags, - ['{http://www.jpeg.org/jpx/1.0/xml}' - + 'GENERAL_CREATION_INFO']) - - # XML box - tags = [x.tag for x in jp2.box[5].xml.getroot()] - self.assertEqual(tags, - ['{http://www.jpeg.org/jpx/1.0/xml}CAPTION', - '{http://www.jpeg.org/jpx/1.0/xml}LOCATION', - '{http://www.jpeg.org/jpx/1.0/xml}THING', - '{http://www.jpeg.org/jpx/1.0/xml}EVENT']) - - def test_NR_file9_dump(self): - # Colormap - jfile = opj_data_file('input/conformance/file9.jp2') - jp2 = Jp2k(jfile) - - ids = [box.box_id for box in jp2.box] - self.assertEqual(ids, ['jP ', 'ftyp', 'jp2h', 'jp2c']) - - ids = [box.box_id for box in jp2.box[2].box] - self.assertEqual(ids, ['ihdr', 'pclr', 'cmap', 'colr']) - - # Signature box. Check for corruption. - self.assertEqual(jp2.box[0].signature, (13, 10, 135, 10)) - - # File type box. - self.assertEqual(jp2.box[1].brand, 'jp2 ') - self.assertEqual(jp2.box[1].compatibility_list[1], 'jp2 ') - self.assertEqual(jp2.box[1].minor_version, 0) - - # Jp2 Header - # Image header - self.assertEqual(jp2.box[2].box[0].height, 512) - self.assertEqual(jp2.box[2].box[0].width, 768) - self.assertEqual(jp2.box[2].box[0].num_components, 1) - self.assertEqual(jp2.box[2].box[0].bits_per_component, 8) - self.assertEqual(jp2.box[2].box[0].signed, False) - self.assertEqual(jp2.box[2].box[0].compression, 7) # wavelet - self.assertEqual(jp2.box[2].box[0].colorspace_unknown, False) - self.assertEqual(jp2.box[2].box[0].ip_provided, False) - - # Palette box. - self.assertEqual(jp2.box[2].box[1].palette.shape, (256, 3)) - np.testing.assert_array_equal(jp2.box[2].box[1].palette[0, 0], 0) - np.testing.assert_array_equal(jp2.box[2].box[1].palette[0, 1], 0) - np.testing.assert_array_equal(jp2.box[2].box[1].palette[0, 2], 0) - np.testing.assert_array_equal(jp2.box[2].box[1].palette[128, 0], 73) - np.testing.assert_array_equal(jp2.box[2].box[1].palette[128, 1], 92) - np.testing.assert_array_equal(jp2.box[2].box[1].palette[128, 2], 53) - np.testing.assert_array_equal(jp2.box[2].box[1].palette[255, 0], 245) - np.testing.assert_array_equal(jp2.box[2].box[1].palette[255, 1], 245) - np.testing.assert_array_equal(jp2.box[2].box[1].palette[255, 2], 245) - - # Component mapping box - self.assertEqual(jp2.box[2].box[2].component_index, (0, 0, 0)) - self.assertEqual(jp2.box[2].box[2].mapping_type, (1, 1, 1)) - self.assertEqual(jp2.box[2].box[2].palette_index, (0, 1, 2)) - - # Jp2 Header - # Colour specification - self.assertEqual(jp2.box[2].box[3].method, - glymur.core.ENUMERATED_COLORSPACE) - self.assertEqual(jp2.box[2].box[3].precedence, 0) - self.assertEqual(jp2.box[2].box[3].approximation, 1) # JPX exact - self.assertIsNone(jp2.box[2].box[3].icc_profile) - self.assertEqual(jp2.box[2].box[3].colorspace, glymur.core.SRGB) - def test_NR_00042_j2k_dump(self): # Profile 3. jfile = opj_data_file('input/nonregression/_00042.j2k') jp2k = Jp2k(jfile) c = jp2k.get_codestream(header_only=False) - # SIZ: Image and tile size - # Profile: "3" means profile 3 - self.assertEqual(c.segment[1].rsiz, 3) - # Reference grid size - self.assertEqual(c.segment[1].xsiz, 1920) - self.assertEqual(c.segment[1].ysiz, 1080) - # Reference grid offset - self.assertEqual((c.segment[1].xosiz, c.segment[1].yosiz), (0, 0)) - # Tile size - self.assertEqual((c.segment[1].xtsiz, c.segment[1].ytsiz), - (1920, 1080)) - # Tile offset - self.assertEqual((c.segment[1].xtosiz, c.segment[1].ytosiz), (0, 0)) - # bitdepth - self.assertEqual(c.segment[1].bitdepth, (12, 12, 12)) - # signed - self.assertEqual(c.segment[1].signed, (False, False, False)) - # subsampling - self.assertEqual(list(zip(c.segment[1].xrsiz, c.segment[1].yrsiz)), - [(1, 1)] * 3) + kwargs = {'rsiz': 3, 'xysiz': (1920, 1080), 'xyosiz': (0, 0), + 'xytsiz': (1920, 1080), 'xytosiz': (0, 0), + 'bitdepth': (12, 12, 12), + 'signed': (False, False, False), + 'xyrsiz': [(1, 1, 1), (1, 1, 1)]} + self.verifySizSegment(c.segment[1], + glymur.codestream.SIZsegment(**kwargs)) # COD: Coding style default self.assertFalse(c.segment[2].scod & 2) # no sop @@ -3093,18 +1690,8 @@ class TestSuiteDump(unittest.TestCase): self.assertEqual(c.segment[2].spcod[3], 1) # mct self.assertEqual(c.segment[2].spcod[4], 5) # level self.assertEqual(tuple(c.segment[2].code_block_size), (32, 32)) - # Selective arithmetic coding bypass - self.assertFalse(c.segment[2].spcod[7] & 0x01) - # Reset context probabilities - self.assertFalse(c.segment[2].spcod[7] & 0x02) - # Termination on each coding pass - self.assertFalse(c.segment[2].spcod[7] & 0x04) - # Vertically causal context - self.assertFalse(c.segment[2].spcod[7] & 0x08) - # Predictable termination - self.assertFalse(c.segment[2].spcod[7] & 0x0010) - # Segmentation symbols - self.assertFalse(c.segment[2].spcod[7] & 0x0020) + self.verify_codeblock_style(c.segment[2].spcod[7], + [False, False, False, False, False, False]) self.assertEqual(c.segment[2].spcod[8], glymur.core.WAVELET_XFORM_9X7_IRREVERSIBLE) self.assertEqual(c.segment[2].precinct_size[0], (128, 128)) @@ -3125,18 +1712,8 @@ class TestSuiteDump(unittest.TestCase): self.assertEqual(c.segment[4].ccoc, 1) self.assertEqual(c.segment[4].spcoc[0], 5) # level self.assertEqual(tuple(c.segment[4].code_block_size), (32, 32)) - # Selective arithmetic coding bypass - self.assertFalse(c.segment[4].spcoc[3] & 0x01) - # Reset context probabilities - self.assertFalse(c.segment[4].spcoc[3] & 0x02) - # Termination on each coding pass - self.assertFalse(c.segment[4].spcoc[3] & 0x04) - # Vertically causal context - self.assertFalse(c.segment[4].spcoc[3] & 0x08) - # Predictable termination - self.assertFalse(c.segment[4].spcoc[3] & 0x0010) - # Segmentation symbols - self.assertFalse(c.segment[4].spcoc[3] & 0x0020) + self.verify_codeblock_style(c.segment[4].spcoc[3], + [False, False, False, False, False, False]) self.assertEqual(c.segment[4].spcoc[4], glymur.core.WAVELET_XFORM_9X7_IRREVERSIBLE) @@ -3157,18 +1734,8 @@ class TestSuiteDump(unittest.TestCase): self.assertEqual(c.segment[6].ccoc, 2) self.assertEqual(c.segment[6].spcoc[0], 5) # level self.assertEqual(tuple(c.segment[6].code_block_size), (32, 32)) - # Selective arithmetic coding bypass - self.assertFalse(c.segment[6].spcoc[3] & 0x01) - # Reset context probabilities - self.assertFalse(c.segment[6].spcoc[3] & 0x02) - # Termination on each coding pass - self.assertFalse(c.segment[6].spcoc[3] & 0x04) - # Vertically causal context - self.assertFalse(c.segment[6].spcoc[3] & 0x08) - # Predictable termination - self.assertFalse(c.segment[6].spcoc[3] & 0x0010) - # Segmentation symbols - self.assertFalse(c.segment[6].spcoc[3] & 0x0020) + self.verify_codeblock_style(c.segment[6].spcoc[3], + [False, False, False, False, False, False]) self.assertEqual(c.segment[6].spcoc[4], glymur.core.WAVELET_XFORM_9X7_IRREVERSIBLE) @@ -3185,12 +1752,8 @@ class TestSuiteDump(unittest.TestCase): [18, 18, 18, 18, 17, 17, 17, 16, 16, 16, 14, 14, 14, 14, 14, 14]) - # COM: comment - # Registration - self.assertEqual(c.segment[8].rcme, glymur.core.RCME_ISO_8859_1) - # Comment value - self.assertEqual(c.segment[8].ccme.decode('latin-1'), - "Created by OpenJPEG version 1.3.0") + pargs = (RCME_ISO_8859_1, "Created by OpenJPEG version 1.3.0".encode()) + self.verifyCMEsegment(c.segment[8], CMEsegment(*pargs)) # TLM (tile-part length) self.assertEqual(c.segment[9].ztlm, 0) @@ -3212,30 +1775,17 @@ class TestSuiteDump(unittest.TestCase): self.assertEqual(c.segment[-1].marker_id, 'EOC') def test_Bretagne2_j2k_dump(self): - # Profile 3. jfile = opj_data_file('input/nonregression/Bretagne2.j2k') jp2k = Jp2k(jfile) c = jp2k.get_codestream(header_only=False) - # SIZ: Image and tile size - # Profile: "3" means profile 3 - self.assertEqual(c.segment[1].rsiz, 0) - # Reference grid size - self.assertEqual(c.segment[1].xsiz, 2592) - self.assertEqual(c.segment[1].ysiz, 1944) - # Reference grid offset - self.assertEqual((c.segment[1].xosiz, c.segment[1].yosiz), (0, 0)) - # Tile size - self.assertEqual((c.segment[1].xtsiz, c.segment[1].ytsiz), (640, 480)) - # Tile offset - self.assertEqual((c.segment[1].xtosiz, c.segment[1].ytosiz), (0, 0)) - # bitdepth - self.assertEqual(c.segment[1].bitdepth, (8, 8, 8)) - # signed - self.assertEqual(c.segment[1].signed, (False, False, False)) - # subsampling - self.assertEqual(list(zip(c.segment[1].xrsiz, c.segment[1].yrsiz)), - [(1, 1)] * 3) + kwargs = {'rsiz': 0, 'xysiz': (2592, 1944), 'xyosiz': (0, 0), + 'xytsiz': (640, 480), 'xytosiz': (0, 0), + 'bitdepth': (8, 8, 8), + 'signed': (False, False, False), + 'xyrsiz': [(1, 1, 1), (1, 1, 1)]} + self.verifySizSegment(c.segment[1], + glymur.codestream.SIZsegment(**kwargs)) # COD: Coding style default self.assertFalse(c.segment[2].scod & 2) # no sop @@ -3245,18 +1795,8 @@ class TestSuiteDump(unittest.TestCase): self.assertEqual(c.segment[2].spcod[3], 1) # mct self.assertEqual(c.segment[2].spcod[4], 5) # level self.assertEqual(tuple(c.segment[2].code_block_size), (32, 32)) - # Selective arithmetic coding bypass - self.assertFalse(c.segment[2].spcod[7] & 0x01) - # Reset context probabilities - self.assertFalse(c.segment[2].spcod[7] & 0x02) - # Termination on each coding pass - self.assertFalse(c.segment[2].spcod[7] & 0x04) - # Vertically causal context - self.assertFalse(c.segment[2].spcod[7] & 0x08) - # Predictable termination - self.assertFalse(c.segment[2].spcod[7] & 0x0010) - # Segmentation symbols - self.assertFalse(c.segment[2].spcod[7] & 0x0020) + self.verify_codeblock_style(c.segment[2].spcod[7], + [False, False, False, False, False, False]) self.assertEqual(c.segment[2].spcod[8], glymur.core.WAVELET_XFORM_5X3_REVERSIBLE) self.assertEqual(c.segment[2].precinct_size, @@ -3274,25 +1814,12 @@ class TestSuiteDump(unittest.TestCase): jp2k = Jp2k(jfile) c = jp2k.get_codestream(header_only=False) - # SIZ: Image and tile size - # Profile: - self.assertEqual(c.segment[1].rsiz, 0) - # Reference grid size - self.assertEqual(c.segment[1].xsiz, 512) - self.assertEqual(c.segment[1].ysiz, 512) - # Reference grid offset - self.assertEqual((c.segment[1].xosiz, c.segment[1].yosiz), (0, 0)) - # Tile size - self.assertEqual((c.segment[1].xtsiz, c.segment[1].ytsiz), (512, 512)) - # Tile offset - self.assertEqual((c.segment[1].xtosiz, c.segment[1].ytosiz), (0, 0)) - # bitdepth - self.assertEqual(c.segment[1].bitdepth, (16,)) - # signed - self.assertEqual(c.segment[1].signed, (False,)) - # subsampling - self.assertEqual(list(zip(c.segment[1].xrsiz, c.segment[1].yrsiz)), - [(1, 1)] * 1) + kwargs = {'rsiz': 0, 'xysiz': (512, 512), 'xyosiz': (0, 0), + 'xytsiz': (512, 512), 'xytosiz': (0, 0), 'bitdepth': (16,), + 'signed': (False,), + 'xyrsiz': [(1,), (1,)]} + self.verifySizSegment(c.segment[1], + glymur.codestream.SIZsegment(**kwargs)) # COD: Coding style default self.assertFalse(c.segment[2].scod & 2) # no sop @@ -3302,18 +1829,8 @@ class TestSuiteDump(unittest.TestCase): self.assertEqual(c.segment[2].spcod[3], 0) # mct self.assertEqual(c.segment[2].spcod[4], 5) # level self.assertEqual(tuple(c.segment[2].code_block_size), (64, 64)) - # Selective arithmetic coding bypass - self.assertFalse(c.segment[2].spcod[7] & 0x01) - # Reset context probabilities - self.assertFalse(c.segment[2].spcod[7] & 0x02) - # Termination on each coding pass - self.assertFalse(c.segment[2].spcod[7] & 0x04) - # Vertically causal context - self.assertFalse(c.segment[2].spcod[7] & 0x08) - # Predictable termination - self.assertFalse(c.segment[2].spcod[7] & 0x0010) - # Segmentation symbols - self.assertFalse(c.segment[2].spcod[7] & 0x0020) + self.verify_codeblock_style(c.segment[2].spcod[7], + [False, False, False, False, False, False]) self.assertEqual(c.segment[2].spcod[8], glymur.core.WAVELET_XFORM_9X7_IRREVERSIBLE) self.assertEqual(len(c.segment[2].spcod), 9) @@ -3327,25 +1844,12 @@ class TestSuiteDump(unittest.TestCase): jp2k = Jp2k(jfile) c = jp2k.get_codestream(header_only=False) - # SIZ: Image and tile size - # Profile: - self.assertEqual(c.segment[1].rsiz, 0) - # Reference grid size - self.assertEqual(c.segment[1].xsiz, 512) - self.assertEqual(c.segment[1].ysiz, 512) - # Reference grid offset - self.assertEqual((c.segment[1].xosiz, c.segment[1].yosiz), (0, 0)) - # Tile size - self.assertEqual((c.segment[1].xtsiz, c.segment[1].ytsiz), (512, 512)) - # Tile offset - self.assertEqual((c.segment[1].xtosiz, c.segment[1].ytosiz), (0, 0)) - # bitdepth - self.assertEqual(c.segment[1].bitdepth, (16,)) - # signed - self.assertEqual(c.segment[1].signed, (False,)) - # subsampling - self.assertEqual(list(zip(c.segment[1].xrsiz, c.segment[1].yrsiz)), - [(1, 1)] * 1) + kwargs = {'rsiz': 0, 'xysiz': (512, 512), 'xyosiz': (0, 0), + 'xytsiz': (512, 512), 'xytosiz': (0, 0), 'bitdepth': (16,), + 'signed': (False,), + 'xyrsiz': [(1,), (1,)]} + self.verifySizSegment(c.segment[1], + glymur.codestream.SIZsegment(**kwargs)) # COD: Coding style default self.assertFalse(c.segment[2].scod & 2) # no sop @@ -3355,18 +1859,8 @@ class TestSuiteDump(unittest.TestCase): self.assertEqual(c.segment[2].spcod[3], 0) # mct self.assertEqual(c.segment[2].spcod[4], 5) # level self.assertEqual(tuple(c.segment[2].code_block_size), (64, 64)) - # Selective arithmetic coding bypass - self.assertFalse(c.segment[2].spcod[7] & 0x01) - # Reset context probabilities - self.assertFalse(c.segment[2].spcod[7] & 0x02) - # Termination on each coding pass - self.assertFalse(c.segment[2].spcod[7] & 0x04) - # Vertically causal context - self.assertFalse(c.segment[2].spcod[7] & 0x08) - # Predictable termination - self.assertFalse(c.segment[2].spcod[7] & 0x0010) - # Segmentation symbols - self.assertFalse(c.segment[2].spcod[7] & 0x0020) + self.verify_codeblock_style(c.segment[2].spcod[7], + [False, False, False, False, False, False]) self.assertEqual(c.segment[2].spcod[8], glymur.core.WAVELET_XFORM_5X3_REVERSIBLE) self.assertEqual(len(c.segment[2].spcod), 9) @@ -3388,26 +1882,12 @@ class TestSuiteDump(unittest.TestCase): expected = ['SOC', 'SIZ', 'COD', 'QCD'] self.assertEqual(ids, expected) - # SIZ: Image and tile size - # Profile: - self.assertEqual(c.segment[1].rsiz, 0) - # Reference grid size - self.assertEqual(c.segment[1].xsiz, 1420) - self.assertEqual(c.segment[1].ysiz, 1416) - # Reference grid offset - self.assertEqual((c.segment[1].xosiz, c.segment[1].yosiz), (0, 0)) - # Tile size - self.assertEqual((c.segment[1].xtsiz, c.segment[1].ytsiz), - (1420, 1416)) - # Tile offset - self.assertEqual((c.segment[1].xtosiz, c.segment[1].ytosiz), (0, 0)) - # bitdepth - self.assertEqual(c.segment[1].bitdepth, (16,)) - # signed - self.assertEqual(c.segment[1].signed, (False,)) - # subsampling - self.assertEqual(list(zip(c.segment[1].xrsiz, c.segment[1].yrsiz)), - [(1, 1)] * 1) + kwargs = {'rsiz': 0, 'xysiz': (1420, 1416), 'xyosiz': (0, 0), + 'xytsiz': (1420, 1416), 'xytosiz': (0, 0), 'bitdepth': (16,), + 'signed': (False,), + 'xyrsiz': [(1,), (1,)]} + self.verifySizSegment(c.segment[1], + glymur.codestream.SIZsegment(**kwargs)) # COD: Coding style default self.assertFalse(c.segment[2].scod & 2) # no sop @@ -3417,18 +1897,8 @@ class TestSuiteDump(unittest.TestCase): self.assertEqual(c.segment[2].spcod[3], 0) # mct self.assertEqual(c.segment[2].spcod[4], 11) # level self.assertEqual(tuple(c.segment[2].code_block_size), (64, 64)) - # Selective arithmetic coding bypass - self.assertFalse(c.segment[2].spcod[7] & 0x01) - # Reset context probabilities - self.assertFalse(c.segment[2].spcod[7] & 0x02) - # Termination on each coding pass - self.assertFalse(c.segment[2].spcod[7] & 0x04) - # Vertically causal context - self.assertFalse(c.segment[2].spcod[7] & 0x08) - # Predictable termination - self.assertFalse(c.segment[2].spcod[7] & 0x0010) - # Segmentation symbols - self.assertFalse(c.segment[2].spcod[7] & 0x0020) + self.verify_codeblock_style(c.segment[2].spcod[7], + [False, False, False, False, False, False]) self.assertEqual(c.segment[2].spcod[8], glymur.core.WAVELET_XFORM_5X3_REVERSIBLE) self.assertEqual(len(c.segment[2].spcod), 9) @@ -3450,25 +1920,12 @@ class TestSuiteDump(unittest.TestCase): expected = ['SOC', 'SIZ', 'COD', 'QCD', 'CME'] self.assertEqual(ids, expected) - # SIZ: Image and tile size - # Profile: - self.assertEqual(c.segment[1].rsiz, 0) - # Reference grid size - self.assertEqual(c.segment[1].xsiz, 512) - self.assertEqual(c.segment[1].ysiz, 614) - # Reference grid offset - self.assertEqual((c.segment[1].xosiz, c.segment[1].yosiz), (0, 0)) - # Tile size - self.assertEqual((c.segment[1].xtsiz, c.segment[1].ytsiz), (512, 614)) - # Tile offset - self.assertEqual((c.segment[1].xtosiz, c.segment[1].ytosiz), (0, 0)) - # bitdepth - self.assertEqual(c.segment[1].bitdepth, (12,)) - # signed - self.assertEqual(c.segment[1].signed, (False,)) - # subsampling - self.assertEqual(list(zip(c.segment[1].xrsiz, c.segment[1].yrsiz)), - [(1, 1)] * 1) + kwargs = {'rsiz': 0, 'xysiz': (512, 614), 'xyosiz': (0, 0), + 'xytsiz': (512, 614), 'xytosiz': (0, 0), 'bitdepth': (12,), + 'signed': (False,), + 'xyrsiz': [(1,), (1,)]} + self.verifySizSegment(c.segment[1], + glymur.codestream.SIZsegment(**kwargs)) # COD: Coding style default self.assertFalse(c.segment[2].scod & 2) # no sop @@ -3478,18 +1935,8 @@ class TestSuiteDump(unittest.TestCase): self.assertEqual(c.segment[2].spcod[3], 0) # mct self.assertEqual(c.segment[2].spcod[4], 5) # level self.assertEqual(tuple(c.segment[2].code_block_size), (64, 64)) - # Selective arithmetic coding bypass - self.assertFalse(c.segment[2].spcod[7] & 0x01) - # Reset context probabilities - self.assertFalse(c.segment[2].spcod[7] & 0x02) - # Termination on each coding pass - self.assertFalse(c.segment[2].spcod[7] & 0x04) - # Vertically causal context - self.assertFalse(c.segment[2].spcod[7] & 0x08) - # Predictable termination - self.assertFalse(c.segment[2].spcod[7] & 0x0010) - # Segmentation symbols - self.assertFalse(c.segment[2].spcod[7] & 0x0020) + self.verify_codeblock_style(c.segment[2].spcod[7], + [False, False, False, False, False, False]) self.assertEqual(c.segment[2].spcod[8], glymur.core.WAVELET_XFORM_9X7_IRREVERSIBLE) self.assertEqual(len(c.segment[2].spcod), 9) @@ -3505,11 +1952,8 @@ class TestSuiteDump(unittest.TestCase): [22, 22, 22, 22, 21, 21, 21, 20, 20, 20, 19, 19, 19, 18, 18, 18]) - # COM: comment - # Registration - self.assertEqual(c.segment[4].rcme, glymur.core.RCME_ISO_8859_1) - # Comment value - self.assertEqual(c.segment[4].ccme.decode('latin-1'), "Kakadu-3.2") + pargs = (RCME_ISO_8859_1, "Kakadu-3.2".encode()) + self.verifyCMEsegment(c.segment[4], CMEsegment(*pargs)) def test_NR_cthead1_dump(self): jfile = opj_data_file('input/nonregression/cthead1.j2k') @@ -3520,25 +1964,12 @@ class TestSuiteDump(unittest.TestCase): expected = ['SOC', 'SIZ', 'COD', 'QCD', 'CME', 'CME'] self.assertEqual(ids, expected) - # SIZ: Image and tile size - # Profile: - self.assertEqual(c.segment[1].rsiz, 0) - # Reference grid size - self.assertEqual(c.segment[1].xsiz, 256) - self.assertEqual(c.segment[1].ysiz, 256) - # Reference grid offset - self.assertEqual((c.segment[1].xosiz, c.segment[1].yosiz), (0, 0)) - # Tile size - self.assertEqual((c.segment[1].xtsiz, c.segment[1].ytsiz), (256, 256)) - # Tile offset - self.assertEqual((c.segment[1].xtosiz, c.segment[1].ytosiz), (0, 0)) - # bitdepth - self.assertEqual(c.segment[1].bitdepth, (8,)) - # signed - self.assertEqual(c.segment[1].signed, (False,)) - # subsampling - self.assertEqual(list(zip(c.segment[1].xrsiz, c.segment[1].yrsiz)), - [(1, 1)] * 1) + kwargs = {'rsiz': 0, 'xysiz': (256, 256), 'xyosiz': (0, 0), + 'xytsiz': (256, 256), 'xytosiz': (0, 0), 'bitdepth': (8,), + 'signed': (False,), + 'xyrsiz': [(1,), (1,)]} + self.verifySizSegment(c.segment[1], + glymur.codestream.SIZsegment(**kwargs)) # COD: Coding style default self.assertFalse(c.segment[2].scod & 2) # no sop @@ -3548,18 +1979,8 @@ class TestSuiteDump(unittest.TestCase): self.assertEqual(c.segment[2].spcod[3], 0) # mct self.assertEqual(c.segment[2].spcod[4], 5) # level self.assertEqual(tuple(c.segment[2].code_block_size), (64, 64)) - # Selective arithmetic coding bypass - self.assertFalse(c.segment[2].spcod[7] & 0x01) - # Reset context probabilities - self.assertFalse(c.segment[2].spcod[7] & 0x02) - # Termination on each coding pass - self.assertFalse(c.segment[2].spcod[7] & 0x04) - # Vertically causal context - self.assertFalse(c.segment[2].spcod[7] & 0x08) - # Predictable termination - self.assertFalse(c.segment[2].spcod[7] & 0x0010) - # Segmentation symbols - self.assertFalse(c.segment[2].spcod[7] & 0x0020) + self.verify_codeblock_style(c.segment[2].spcod[7], + [False, False, False, False, False, False]) self.assertEqual(c.segment[2].spcod[8], glymur.core.WAVELET_XFORM_5X3_REVERSIBLE) self.assertEqual(len(c.segment[2].spcod), 9) @@ -3573,17 +1994,8 @@ class TestSuiteDump(unittest.TestCase): [9, 10, 10, 11, 10, 10, 11, 10, 10, 11, 10, 10, 10, 9, 9, 10]) - # COM: comment - # Registration - self.assertEqual(c.segment[4].rcme, glymur.core.RCME_ISO_8859_1) - # Comment value - self.assertEqual(c.segment[4].ccme.decode('latin-1'), "Kakadu-v6.3.1") - - # COM: comment - # Registration - self.assertEqual(c.segment[4].rcme, glymur.core.RCME_ISO_8859_1) - # Comment value - self.assertEqual(c.segment[4].ccme.decode('latin-1'), "Kakadu-v6.3.1") + pargs = (RCME_ISO_8859_1, "Kakadu-v6.3.1".encode()) + self.verifyCMEsegment(c.segment[4], CMEsegment(*pargs)) def test_NR_illegalcolortransform_dump(self): jfile = opj_data_file('input/nonregression/illegalcolortransform.j2k') @@ -3594,26 +2006,12 @@ class TestSuiteDump(unittest.TestCase): expected = ['SOC', 'SIZ', 'COD', 'QCD'] self.assertEqual(ids, expected) - # SIZ: Image and tile size - # Profile: - self.assertEqual(c.segment[1].rsiz, 0) - # Reference grid size - self.assertEqual(c.segment[1].xsiz, 1420) - self.assertEqual(c.segment[1].ysiz, 1416) - # Reference grid offset - self.assertEqual((c.segment[1].xosiz, c.segment[1].yosiz), (0, 0)) - # Tile size - self.assertEqual((c.segment[1].xtsiz, c.segment[1].ytsiz), - (1420, 1416)) - # Tile offset - self.assertEqual((c.segment[1].xtosiz, c.segment[1].ytosiz), (0, 0)) - # bitdepth - self.assertEqual(c.segment[1].bitdepth, (16,)) - # signed - self.assertEqual(c.segment[1].signed, (False,)) - # subsampling - self.assertEqual(list(zip(c.segment[1].xrsiz, c.segment[1].yrsiz)), - [(1, 1)] * 1) + kwargs = {'rsiz': 0, 'xysiz': (1420, 1416), 'xyosiz': (0, 0), + 'xytsiz': (1420, 1416), 'xytosiz': (0, 0), 'bitdepth': (16,), + 'signed': (False,), + 'xyrsiz': [(1,), (1,)]} + self.verifySizSegment(c.segment[1], + glymur.codestream.SIZsegment(**kwargs)) # COD: Coding style default self.assertFalse(c.segment[2].scod & 2) # no sop @@ -3623,18 +2021,8 @@ class TestSuiteDump(unittest.TestCase): self.assertEqual(c.segment[2].spcod[3], 1) # mct self.assertEqual(c.segment[2].spcod[4], 11) # level self.assertEqual(tuple(c.segment[2].code_block_size), (64, 64)) - # Selective arithmetic coding bypass - self.assertFalse(c.segment[2].spcod[7] & 0x01) - # Reset context probabilities - self.assertFalse(c.segment[2].spcod[7] & 0x02) - # Termination on each coding pass - self.assertFalse(c.segment[2].spcod[7] & 0x04) - # Vertically causal context - self.assertFalse(c.segment[2].spcod[7] & 0x08) - # Predictable termination - self.assertFalse(c.segment[2].spcod[7] & 0x0010) - # Segmentation symbols - self.assertFalse(c.segment[2].spcod[7] & 0x0020) + self.verify_codeblock_style(c.segment[2].spcod[7], + [False, False, False, False, False, False]) self.assertEqual(c.segment[2].spcod[8], glymur.core.WAVELET_XFORM_5X3_REVERSIBLE) self.assertEqual(len(c.segment[2].spcod), 9) @@ -3655,25 +2043,13 @@ class TestSuiteDump(unittest.TestCase): expected = ['SOC', 'SIZ', 'COD', 'QCD', 'CME'] self.assertEqual(ids, expected) - # SIZ: Image and tile size - # Profile: - self.assertEqual(c.segment[1].rsiz, 0) - # Reference grid size - self.assertEqual(c.segment[1].xsiz, 256) - self.assertEqual(c.segment[1].ysiz, 256) - # Reference grid offset - self.assertEqual((c.segment[1].xosiz, c.segment[1].yosiz), (0, 0)) - # Tile size - self.assertEqual((c.segment[1].xtsiz, c.segment[1].ytsiz), (256, 256)) - # Tile offset - self.assertEqual((c.segment[1].xtosiz, c.segment[1].ytosiz), (0, 0)) - # bitdepth - self.assertEqual(c.segment[1].bitdepth, (8, 8, 8)) - # signed - self.assertEqual(c.segment[1].signed, (True, True, True)) - # subsampling - self.assertEqual(list(zip(c.segment[1].xrsiz, c.segment[1].yrsiz)), - [(1, 1)] * 3) + kwargs = {'rsiz': 0, 'xysiz': (256, 256), 'xyosiz': (0, 0), + 'xytsiz': (256, 256), 'xytosiz': (0, 0), + 'bitdepth': (8, 8, 8), + 'signed': (True, True, True), + 'xyrsiz': [(1, 1, 1), (1, 1, 1)]} + self.verifySizSegment(c.segment[1], + glymur.codestream.SIZsegment(**kwargs)) # COD: Coding style default self.assertFalse(c.segment[2].scod & 2) # no sop @@ -3683,18 +2059,8 @@ class TestSuiteDump(unittest.TestCase): self.assertEqual(c.segment[2].spcod[3], 1) # mct self.assertEqual(c.segment[2].spcod[4], 5) # level self.assertEqual(tuple(c.segment[2].code_block_size), (64, 64)) - # Selective arithmetic coding bypass - self.assertFalse(c.segment[2].spcod[7] & 0x01) - # Reset context probabilities - self.assertFalse(c.segment[2].spcod[7] & 0x02) - # Termination on each coding pass - self.assertFalse(c.segment[2].spcod[7] & 0x04) - # Vertically causal context - self.assertFalse(c.segment[2].spcod[7] & 0x08) - # Predictable termination - self.assertFalse(c.segment[2].spcod[7] & 0x0010) - # Segmentation symbols - self.assertFalse(c.segment[2].spcod[7] & 0x0020) + self.verify_codeblock_style(c.segment[2].spcod[7], + [False, False, False, False, False, False]) self.assertEqual(c.segment[2].spcod[8], glymur.core.WAVELET_XFORM_5X3_REVERSIBLE) self.assertEqual(len(c.segment[2].spcod), 9) @@ -3707,11 +2073,8 @@ class TestSuiteDump(unittest.TestCase): self.assertEqual(c.segment[3].exponent, [8, 9, 9, 10, 9, 9, 10, 9, 9, 10, 9, 9, 10, 9, 9, 10]) - # COM: comment - # Registration - self.assertEqual(c.segment[4].rcme, glymur.core.RCME_BINARY) - # Comment value - self.assertEqual(len(c.segment[4].ccme), 36) + pargs = (RCME_BINARY, c.segment[4].ccme) + self.verifyCMEsegment(c.segment[4], CMEsegment(*pargs)) def test_NR_kakadu_v4_4_openjpegv2_broken_dump(self): jfile = opj_data_file('input/nonregression/' @@ -3719,26 +2082,12 @@ class TestSuiteDump(unittest.TestCase): jp2k = Jp2k(jfile) c = jp2k.get_codestream() - # SIZ: Image and tile size - # Profile: - self.assertEqual(c.segment[1].rsiz, 0) - # Reference grid size - self.assertEqual(c.segment[1].xsiz, 2048) - self.assertEqual(c.segment[1].ysiz, 2500) - # Reference grid offset - self.assertEqual((c.segment[1].xosiz, c.segment[1].yosiz), (0, 0)) - # Tile size - self.assertEqual((c.segment[1].xtsiz, c.segment[1].ytsiz), - (2048, 2500)) - # Tile offset - self.assertEqual((c.segment[1].xtosiz, c.segment[1].ytosiz), (0, 0)) - # bitdepth - self.assertEqual(c.segment[1].bitdepth, (16,)) - # signed - self.assertEqual(c.segment[1].signed, (False,)) - # subsampling - self.assertEqual(list(zip(c.segment[1].xrsiz, c.segment[1].yrsiz)), - [(1, 1)] * 1) + kwargs = {'rsiz': 0, 'xysiz': (2048, 2500), 'xyosiz': (0, 0), + 'xytsiz': (2048, 2500), 'xytosiz': (0, 0), 'bitdepth': (16,), + 'signed': (False,), + 'xyrsiz': [(1,), (1,)]} + self.verifySizSegment(c.segment[1], + glymur.codestream.SIZsegment(**kwargs)) # COD: Coding style default self.assertFalse(c.segment[2].scod & 2) # no sop @@ -3748,18 +2097,8 @@ class TestSuiteDump(unittest.TestCase): self.assertEqual(c.segment[2].spcod[3], 0) # mct self.assertEqual(c.segment[2].spcod[4], 8) # level self.assertEqual(tuple(c.segment[2].code_block_size), (64, 64)) - # Selective arithmetic coding bypass - self.assertFalse(c.segment[2].spcod[7] & 0x01) - # Reset context probabilities - self.assertFalse(c.segment[2].spcod[7] & 0x02) - # Termination on each coding pass - self.assertFalse(c.segment[2].spcod[7] & 0x04) - # Vertically causal context - self.assertFalse(c.segment[2].spcod[7] & 0x08) - # Predictable termination - self.assertFalse(c.segment[2].spcod[7] & 0x0010) - # Segmentation symbols - self.assertFalse(c.segment[2].spcod[7] & 0x0020) + self.verify_codeblock_style(c.segment[2].spcod[7], + [False, False, False, False, False, False]) self.assertEqual(c.segment[2].spcod[8], glymur.core.WAVELET_XFORM_5X3_REVERSIBLE) self.assertEqual(len(c.segment[2].spcod), 9) @@ -3772,57 +2111,37 @@ class TestSuiteDump(unittest.TestCase): [17, 18, 18, 19, 18, 18, 19, 18, 18, 19, 18, 18, 19, 18, 18, 19, 18, 18, 19, 18, 18, 19, 18, 18, 19]) - # COM: comment - # Registration - self.assertEqual(c.segment[4].rcme, glymur.core.RCME_ISO_8859_1) - # Comment value - self.assertEqual(c.segment[4].ccme.decode('latin-1'), "Kakadu-v4.4") + pargs = (RCME_ISO_8859_1, "Kakadu-v4.4".encode()) + self.verifyCMEsegment(c.segment[4], CMEsegment(*pargs)) - # COM: comment - # Registration - self.assertEqual(c.segment[5].rcme, glymur.core.RCME_ISO_8859_1) - # Comment value - expected = "Kdu-Layer-Info: log_2{Delta-D(MSE)/[2^16*Delta-L(bytes)]}," - expected += " L(bytes)\n" - expected += " -65.4, 6.8e+004\n" - expected += " -66.3, 1.0e+005\n" - expected += " -67.3, 2.0e+005\n" - expected += " -68.5, 4.1e+005\n" - expected += " -69.0, 5.1e+005\n" - expected += " -69.5, 5.9e+005\n" - expected += " -69.7, 6.8e+005\n" - expected += " -70.3, 8.2e+005\n" - expected += " -70.8, 1.0e+006\n" - expected += " -71.9, 1.4e+006\n" - expected += " -73.8, 2.0e+006\n" - expected += "-256.0, 3.7e+006\n" - self.assertEqual(c.segment[5].ccme.decode('latin-1'), expected) + ccme = "Kdu-Layer-Info: log_2{Delta-D(MSE)/[2^16*Delta-L(bytes)]}," + ccme += " L(bytes)\n" + ccme += " -65.4, 6.8e+004\n" + ccme += " -66.3, 1.0e+005\n" + ccme += " -67.3, 2.0e+005\n" + ccme += " -68.5, 4.1e+005\n" + ccme += " -69.0, 5.1e+005\n" + ccme += " -69.5, 5.9e+005\n" + ccme += " -69.7, 6.8e+005\n" + ccme += " -70.3, 8.2e+005\n" + ccme += " -70.8, 1.0e+006\n" + ccme += " -71.9, 1.4e+006\n" + ccme += " -73.8, 2.0e+006\n" + ccme += "-256.0, 3.7e+006\n" + pargs = (RCME_ISO_8859_1, ccme.encode()) + self.verifyCMEsegment(c.segment[5], CMEsegment(*pargs)) def test_NR_MarkerIsNotCompliant_j2k_dump(self): jfile = opj_data_file('input/nonregression/MarkerIsNotCompliant.j2k') jp2k = Jp2k(jfile) c = jp2k.get_codestream() - # SIZ: Image and tile size - # Profile: - self.assertEqual(c.segment[1].rsiz, 0) - # Reference grid size - self.assertEqual(c.segment[1].xsiz, 1420) - self.assertEqual(c.segment[1].ysiz, 1416) - # Reference grid offset - self.assertEqual((c.segment[1].xosiz, c.segment[1].yosiz), (0, 0)) - # Tile size - self.assertEqual((c.segment[1].xtsiz, c.segment[1].ytsiz), - (1420, 1416)) - # Tile offset - self.assertEqual((c.segment[1].xtosiz, c.segment[1].ytosiz), (0, 0)) - # bitdepth - self.assertEqual(c.segment[1].bitdepth, (16,)) - # signed - self.assertEqual(c.segment[1].signed, (False,)) - # subsampling - self.assertEqual(list(zip(c.segment[1].xrsiz, c.segment[1].yrsiz)), - [(1, 1)] * 1) + kwargs = {'rsiz': 0, 'xysiz': (1420, 1416), 'xyosiz': (0, 0), + 'xytsiz': (1420, 1416), 'xytosiz': (0, 0), 'bitdepth': (16,), + 'signed': (False,), + 'xyrsiz': [(1,), (1,)]} + self.verifySizSegment(c.segment[1], + glymur.codestream.SIZsegment(**kwargs)) # COD: Coding style default self.assertFalse(c.segment[2].scod & 2) # no sop @@ -3832,18 +2151,8 @@ class TestSuiteDump(unittest.TestCase): self.assertEqual(c.segment[2].spcod[3], 0) # mct self.assertEqual(c.segment[2].spcod[4], 11) # level self.assertEqual(tuple(c.segment[2].code_block_size), (64, 64)) - # Selective arithmetic coding bypass - self.assertFalse(c.segment[2].spcod[7] & 0x01) - # Reset context probabilities - self.assertFalse(c.segment[2].spcod[7] & 0x02) - # Termination on each coding pass - self.assertFalse(c.segment[2].spcod[7] & 0x04) - # Vertically causal context - self.assertFalse(c.segment[2].spcod[7] & 0x08) - # Predictable termination - self.assertFalse(c.segment[2].spcod[7] & 0x0010) - # Segmentation symbols - self.assertFalse(c.segment[2].spcod[7] & 0x0020) + self.verify_codeblock_style(c.segment[2].spcod[7], + [False, False, False, False, False, False]) self.assertEqual(c.segment[2].spcod[8], glymur.core.WAVELET_XFORM_5X3_REVERSIBLE) self.assertEqual(len(c.segment[2].spcod), 9) @@ -3862,26 +2171,13 @@ class TestSuiteDump(unittest.TestCase): jp2k = Jp2k(jfile) c = jp2k.get_codestream() - # SIZ: Image and tile size - # Profile: - self.assertEqual(c.segment[1].rsiz, 0) - # Reference grid size - self.assertEqual(c.segment[1].xsiz, 1920) - self.assertEqual(c.segment[1].ysiz, 1080) - # Reference grid offset - self.assertEqual((c.segment[1].xosiz, c.segment[1].yosiz), (0, 0)) - # Tile size - self.assertEqual((c.segment[1].xtsiz, c.segment[1].ytsiz), - (1920, 1080)) - # Tile offset - self.assertEqual((c.segment[1].xtosiz, c.segment[1].ytosiz), (0, 0)) - # bitdepth - self.assertEqual(c.segment[1].bitdepth, (8, 8, 8)) - # signed - self.assertEqual(c.segment[1].signed, (False, False, False)) - # subsampling - self.assertEqual(list(zip(c.segment[1].xrsiz, c.segment[1].yrsiz)), - [(1, 1)] * 3) + kwargs = {'rsiz': 0, 'xysiz': (1920, 1080), 'xyosiz': (0, 0), + 'xytsiz': (1920, 1080), 'xytosiz': (0, 0), + 'bitdepth': (8, 8, 8), + 'signed': (False, False, False), + 'xyrsiz': [(1, 1, 1), (1, 1, 1)]} + self.verifySizSegment(c.segment[1], + glymur.codestream.SIZsegment(**kwargs)) # COD: Coding style default self.assertFalse(c.segment[2].scod & 2) # no sop @@ -3891,18 +2187,8 @@ class TestSuiteDump(unittest.TestCase): self.assertEqual(c.segment[2].spcod[3], 1) # mct self.assertEqual(c.segment[2].spcod[4], 5) # level self.assertEqual(tuple(c.segment[2].code_block_size), (64, 64)) - # Selective arithmetic coding bypass - self.assertFalse(c.segment[2].spcod[7] & 0x01) - # Reset context probabilities - self.assertFalse(c.segment[2].spcod[7] & 0x02) - # Termination on each coding pass - self.assertFalse(c.segment[2].spcod[7] & 0x04) - # Vertically causal context - self.assertFalse(c.segment[2].spcod[7] & 0x08) - # Predictable termination - self.assertFalse(c.segment[2].spcod[7] & 0x0010) - # Segmentation symbols - self.assertFalse(c.segment[2].spcod[7] & 0x0020) + self.verify_codeblock_style(c.segment[2].spcod[7], + [False, False, False, False, False, False]) self.assertEqual(c.segment[2].spcod[8], glymur.core.WAVELET_XFORM_5X3_REVERSIBLE) self.assertEqual(len(c.segment[2].spcod), 9) @@ -3919,26 +2205,13 @@ class TestSuiteDump(unittest.TestCase): jp2k = Jp2k(jfile) c = jp2k.get_codestream() - # SIZ: Image and tile size - # Profile: - self.assertEqual(c.segment[1].rsiz, 0) - # Reference grid size - self.assertEqual(c.segment[1].xsiz, 1920) - self.assertEqual(c.segment[1].ysiz, 1080) - # Reference grid offset - self.assertEqual((c.segment[1].xosiz, c.segment[1].yosiz), (0, 0)) - # Tile size - self.assertEqual((c.segment[1].xtsiz, c.segment[1].ytsiz), - (1920, 1080)) - # Tile offset - self.assertEqual((c.segment[1].xtosiz, c.segment[1].ytosiz), (0, 0)) - # bitdepth - self.assertEqual(c.segment[1].bitdepth, (8, 8, 8)) - # signed - self.assertEqual(c.segment[1].signed, (False, False, False)) - # subsampling - self.assertEqual(list(zip(c.segment[1].xrsiz, c.segment[1].yrsiz)), - [(1, 1)] * 3) + kwargs = {'rsiz': 0, 'xysiz': (1920, 1080), 'xyosiz': (0, 0), + 'xytsiz': (1920, 1080), 'xytosiz': (0, 0), + 'bitdepth': (8, 8, 8), + 'signed': (False, False, False), + 'xyrsiz': [(1, 1, 1), (1, 1, 1)]} + self.verifySizSegment(c.segment[1], + glymur.codestream.SIZsegment(**kwargs)) # COD: Coding style default self.assertFalse(c.segment[2].scod & 2) # no sop @@ -3948,18 +2221,8 @@ class TestSuiteDump(unittest.TestCase): self.assertEqual(c.segment[2].spcod[3], 1) # mct self.assertEqual(c.segment[2].spcod[4], 5) # level self.assertEqual(tuple(c.segment[2].code_block_size), (64, 64)) - # Selective arithmetic coding bypass - self.assertFalse(c.segment[2].spcod[7] & 0x01) - # Reset context probabilities - self.assertFalse(c.segment[2].spcod[7] & 0x02) - # Termination on each coding pass - self.assertFalse(c.segment[2].spcod[7] & 0x04) - # Vertically causal context - self.assertFalse(c.segment[2].spcod[7] & 0x08) - # Predictable termination - self.assertFalse(c.segment[2].spcod[7] & 0x0010) - # Segmentation symbols - self.assertFalse(c.segment[2].spcod[7] & 0x0020) + self.verify_codeblock_style(c.segment[2].spcod[7], + [False, False, False, False, False, False]) self.assertEqual(c.segment[2].spcod[8], glymur.core.WAVELET_XFORM_5X3_REVERSIBLE) self.assertEqual(len(c.segment[2].spcod), 9) @@ -3976,26 +2239,13 @@ class TestSuiteDump(unittest.TestCase): jp2k = Jp2k(jfile) c = jp2k.get_codestream() - # SIZ: Image and tile size - # Profile: - self.assertEqual(c.segment[1].rsiz, 0) - # Reference grid size - self.assertEqual(c.segment[1].xsiz, 1920) - self.assertEqual(c.segment[1].ysiz, 1080) - # Reference grid offset - self.assertEqual((c.segment[1].xosiz, c.segment[1].yosiz), (0, 0)) - # Tile size - self.assertEqual((c.segment[1].xtsiz, c.segment[1].ytsiz), - (1920, 1080)) - # Tile offset - self.assertEqual((c.segment[1].xtosiz, c.segment[1].ytosiz), (0, 0)) - # bitdepth - self.assertEqual(c.segment[1].bitdepth, (8, 8, 8)) - # signed - self.assertEqual(c.segment[1].signed, (False, False, False)) - # subsampling - self.assertEqual(list(zip(c.segment[1].xrsiz, c.segment[1].yrsiz)), - [(1, 1)] * 3) + kwargs = {'rsiz': 0, 'xysiz': (1920, 1080), 'xyosiz': (0, 0), + 'xytsiz': (1920, 1080), 'xytosiz': (0, 0), + 'bitdepth': (8, 8, 8), + 'signed': (False, False, False), + 'xyrsiz': [(1, 1, 1), (1, 1, 1)]} + self.verifySizSegment(c.segment[1], + glymur.codestream.SIZsegment(**kwargs)) # COD: Coding style default self.assertFalse(c.segment[2].scod & 2) # no sop @@ -4005,18 +2255,8 @@ class TestSuiteDump(unittest.TestCase): self.assertEqual(c.segment[2].spcod[3], 1) # mct self.assertEqual(c.segment[2].spcod[4], 5) # level self.assertEqual(tuple(c.segment[2].code_block_size), (64, 64)) - # Selective arithmetic coding bypass - self.assertFalse(c.segment[2].spcod[7] & 0x01) - # Reset context probabilities - self.assertFalse(c.segment[2].spcod[7] & 0x02) - # Termination on each coding pass - self.assertFalse(c.segment[2].spcod[7] & 0x04) - # Vertically causal context - self.assertFalse(c.segment[2].spcod[7] & 0x08) - # Predictable termination - self.assertFalse(c.segment[2].spcod[7] & 0x0010) - # Segmentation symbols - self.assertFalse(c.segment[2].spcod[7] & 0x0020) + self.verify_codeblock_style(c.segment[2].spcod[7], + [False, False, False, False, False, False]) self.assertEqual(c.segment[2].spcod[8], glymur.core.WAVELET_XFORM_5X3_REVERSIBLE) self.assertEqual(len(c.segment[2].spcod), 9) @@ -4037,25 +2277,13 @@ class TestSuiteDump(unittest.TestCase): expected = ['SOC', 'SIZ', 'COD', 'QCD'] self.assertEqual(ids, expected) - # SIZ: Image and tile size - # Profile: - self.assertEqual(c.segment[1].rsiz, 0) - # Reference grid size - self.assertEqual(c.segment[1].xsiz, 117) - self.assertEqual(c.segment[1].ysiz, 117) - # Reference grid offset - self.assertEqual((c.segment[1].xosiz, c.segment[1].yosiz), (0, 0)) - # Tile size - self.assertEqual((c.segment[1].xtsiz, c.segment[1].ytsiz), (117, 117)) - # Tile offset - self.assertEqual((c.segment[1].xtosiz, c.segment[1].ytosiz), (0, 0)) - # bitdepth - self.assertEqual(c.segment[1].bitdepth, (8, 8, 8, 8)) - # signed - self.assertEqual(c.segment[1].signed, (False, False, False, False)) - # subsampling - self.assertEqual(list(zip(c.segment[1].xrsiz, c.segment[1].yrsiz)), - [(1, 1)] * 4) + kwargs = {'rsiz': 0, 'xysiz': (117, 117), 'xyosiz': (0, 0), + 'xytsiz': (117, 117), 'xytosiz': (0, 0), + 'bitdepth': (8, 8, 8, 8), + 'signed': (False, False, False, False), + 'xyrsiz': [(1, 1, 1, 1), (1, 1, 1, 1)]} + self.verifySizSegment(c.segment[1], + glymur.codestream.SIZsegment(**kwargs)) # COD: Coding style default self.assertFalse(c.segment[2].scod & 2) # no sop @@ -4065,18 +2293,8 @@ class TestSuiteDump(unittest.TestCase): self.assertEqual(c.segment[2].spcod[3], 0) # mct self.assertEqual(c.segment[2].spcod[4], 5) # level self.assertEqual(tuple(c.segment[2].code_block_size), (64, 64)) - # Selective arithmetic coding bypass - self.assertFalse(c.segment[2].spcod[7] & 0x01) - # Reset context probabilities - self.assertFalse(c.segment[2].spcod[7] & 0x02) - # Termination on each coding pass - self.assertFalse(c.segment[2].spcod[7] & 0x04) - # Vertically causal context - self.assertFalse(c.segment[2].spcod[7] & 0x08) - # Predictable termination - self.assertFalse(c.segment[2].spcod[7] & 0x0010) - # Segmentation symbols - self.assertFalse(c.segment[2].spcod[7] & 0x0020) + self.verify_codeblock_style(c.segment[2].spcod[7], + [False, False, False, False, False, False]) self.assertEqual(c.segment[2].spcod[8], glymur.core.WAVELET_XFORM_5X3_REVERSIBLE) self.assertEqual(len(c.segment[2].spcod), 9) @@ -4097,25 +2315,13 @@ class TestSuiteDump(unittest.TestCase): expected = ['SOC', 'SIZ', 'COD', 'QCD'] self.assertEqual(ids, expected) - # SIZ: Image and tile size - # Profile: - self.assertEqual(c.segment[1].rsiz, 0) - # Reference grid size - self.assertEqual(c.segment[1].xsiz, 117) - self.assertEqual(c.segment[1].ysiz, 117) - # Reference grid offset - self.assertEqual((c.segment[1].xosiz, c.segment[1].yosiz), (0, 0)) - # Tile size - self.assertEqual((c.segment[1].xtsiz, c.segment[1].ytsiz), (117, 117)) - # Tile offset - self.assertEqual((c.segment[1].xtosiz, c.segment[1].ytosiz), (0, 0)) - # bitdepth - self.assertEqual(c.segment[1].bitdepth, (8, 8, 8, 8)) - # signed - self.assertEqual(c.segment[1].signed, (False, False, False, False)) - # subsampling - self.assertEqual(list(zip(c.segment[1].xrsiz, c.segment[1].yrsiz)), - [(1, 1)] * 4) + kwargs = {'rsiz': 0, 'xysiz': (117, 117), 'xyosiz': (0, 0), + 'xytsiz': (117, 117), 'xytosiz': (0, 0), + 'bitdepth': (8, 8, 8, 8), + 'signed': (False, False, False, False), + 'xyrsiz': [(1, 1, 1, 1), (1, 1, 1, 1)]} + self.verifySizSegment(c.segment[1], + glymur.codestream.SIZsegment(**kwargs)) # COD: Coding style default self.assertFalse(c.segment[2].scod & 2) # no sop @@ -4125,18 +2331,8 @@ class TestSuiteDump(unittest.TestCase): self.assertEqual(c.segment[2].spcod[3], 0) # mct self.assertEqual(c.segment[2].spcod[4], 5) # level self.assertEqual(tuple(c.segment[2].code_block_size), (64, 64)) - # Selective arithmetic coding bypass - self.assertFalse(c.segment[2].spcod[7] & 0x01) - # Reset context probabilities - self.assertFalse(c.segment[2].spcod[7] & 0x02) - # Termination on each coding pass - self.assertFalse(c.segment[2].spcod[7] & 0x04) - # Vertically causal context - self.assertFalse(c.segment[2].spcod[7] & 0x08) - # Predictable termination - self.assertFalse(c.segment[2].spcod[7] & 0x0010) - # Segmentation symbols - self.assertFalse(c.segment[2].spcod[7] & 0x0020) + self.verify_codeblock_style(c.segment[2].spcod[7], + [False, False, False, False, False, False]) self.assertEqual(c.segment[2].spcod[8], glymur.core.WAVELET_XFORM_5X3_REVERSIBLE) self.assertEqual(len(c.segment[2].spcod), 9) @@ -4157,25 +2353,13 @@ class TestSuiteDump(unittest.TestCase): expected = ['SOC', 'SIZ', 'COD', 'QCD', 'CME'] self.assertEqual(ids, expected) - # SIZ: Image and tile size - # Profile: - self.assertEqual(c.segment[1].rsiz, 0) - # Reference grid size - self.assertEqual(c.segment[1].xsiz, 512) - self.assertEqual(c.segment[1].ysiz, 512) - # Reference grid offset - self.assertEqual((c.segment[1].xosiz, c.segment[1].yosiz), (0, 0)) - # Tile size - self.assertEqual((c.segment[1].xtsiz, c.segment[1].ytsiz), (512, 512)) - # Tile offset - self.assertEqual((c.segment[1].xtosiz, c.segment[1].ytosiz), (0, 0)) - # bitdepth - self.assertEqual(c.segment[1].bitdepth, (16,)) - # signed - self.assertEqual(c.segment[1].signed, (True,)) - # subsampling - self.assertEqual(list(zip(c.segment[1].xrsiz, c.segment[1].yrsiz)), - [(1, 1)] * 1) + kwargs = {'rsiz': 0, 'xysiz': (512, 512), 'xyosiz': (0, 0), + 'xytsiz': (512, 512), 'xytosiz': (0, 0), + 'bitdepth': (16,), + 'signed': (False,), + 'xyrsiz': [(1,), (1,)]} + self.verifySizSegment(c.segment[1], + glymur.codestream.SIZsegment(**kwargs)) # COD: Coding style default self.assertFalse(c.segment[2].scod & 2) # no sop @@ -4185,18 +2369,8 @@ class TestSuiteDump(unittest.TestCase): self.assertEqual(c.segment[2].spcod[3], 0) # mct self.assertEqual(c.segment[2].spcod[4], 5) # level self.assertEqual(tuple(c.segment[2].code_block_size), (64, 64)) - # Selective arithmetic coding bypass - self.assertFalse(c.segment[2].spcod[7] & 0x01) - # Reset context probabilities - self.assertFalse(c.segment[2].spcod[7] & 0x02) - # Termination on each coding pass - self.assertFalse(c.segment[2].spcod[7] & 0x04) - # Vertically causal context - self.assertFalse(c.segment[2].spcod[7] & 0x08) - # Predictable termination - self.assertFalse(c.segment[2].spcod[7] & 0x0010) - # Segmentation symbols - self.assertFalse(c.segment[2].spcod[7] & 0x0020) + self.verify_codeblock_style(c.segment[2].spcod[7], + [False, False, False, False, False, False]) self.assertEqual(c.segment[2].spcod[8], glymur.core.WAVELET_XFORM_5X3_REVERSIBLE) self.assertEqual(len(c.segment[2].spcod), 9) @@ -4209,12 +2383,8 @@ class TestSuiteDump(unittest.TestCase): [18, 19, 19, 20, 19, 19, 20, 19, 19, 20, 19, 19, 20, 19, 19, 20]) - # COM: comment - # Registration - self.assertEqual(c.segment[4].rcme, glymur.core.RCME_ISO_8859_1) - # Comment value - self.assertEqual(c.segment[4].ccme.decode('latin-1'), - "Kakadu-2.0.2") + pargs = (RCME_ISO_8859_1, "Kakadu-2.0.2".encode()) + self.verifyCMEsegment(c.segment[4], CMEsegment(*pargs)) def test_NR_test_lossless_j2k_dump(self): jfile = opj_data_file('input/nonregression/test_lossless.j2k') @@ -4225,26 +2395,13 @@ class TestSuiteDump(unittest.TestCase): expected = ['SOC', 'SIZ', 'COD', 'QCD', 'CME'] self.assertEqual(ids, expected) - # SIZ: Image and tile size - # Profile: - self.assertEqual(c.segment[1].rsiz, 0) - # Reference grid size - self.assertEqual(c.segment[1].xsiz, 1024) - self.assertEqual(c.segment[1].ysiz, 1024) - # Reference grid offset - self.assertEqual((c.segment[1].xosiz, c.segment[1].yosiz), (0, 0)) - # Tile size - self.assertEqual((c.segment[1].xtsiz, c.segment[1].ytsiz), - (1024, 1024)) - # Tile offset - self.assertEqual((c.segment[1].xtosiz, c.segment[1].ytosiz), (0, 0)) - # bitdepth - self.assertEqual(c.segment[1].bitdepth, (12,)) - # signed - self.assertEqual(c.segment[1].signed, (False,)) - # subsampling - self.assertEqual(list(zip(c.segment[1].xrsiz, c.segment[1].yrsiz)), - [(1, 1)] * 1) + kwargs = {'rsiz': 0, 'xysiz': (1024, 1024), 'xyosiz': (0, 0), + 'xytsiz': (1024, 1024), 'xytosiz': (0, 0), + 'bitdepth': (12,), + 'signed': (False,), + 'xyrsiz': [(1,), (1,)]} + self.verifySizSegment(c.segment[1], + glymur.codestream.SIZsegment(**kwargs)) # COD: Coding style default self.assertFalse(c.segment[2].scod & 2) # no sop @@ -4254,18 +2411,8 @@ class TestSuiteDump(unittest.TestCase): self.assertEqual(c.segment[2].spcod[3], 0) # mct self.assertEqual(c.segment[2].spcod[4], 5) # level self.assertEqual(tuple(c.segment[2].code_block_size), (64, 64)) - # Selective arithmetic coding bypass - self.assertFalse(c.segment[2].spcod[7] & 0x01) - # Reset context probabilities - self.assertFalse(c.segment[2].spcod[7] & 0x02) - # Termination on each coding pass - self.assertFalse(c.segment[2].spcod[7] & 0x04) - # Vertically causal context - self.assertFalse(c.segment[2].spcod[7] & 0x08) - # Predictable termination - self.assertFalse(c.segment[2].spcod[7] & 0x0010) - # Segmentation symbols - self.assertFalse(c.segment[2].spcod[7] & 0x0020) + self.verify_codeblock_style(c.segment[2].spcod[7], + [False, False, False, False, False, False]) self.assertEqual(c.segment[2].spcod[8], glymur.core.WAVELET_XFORM_5X3_REVERSIBLE) self.assertEqual(len(c.segment[2].spcod), 9) @@ -4278,12 +2425,8 @@ class TestSuiteDump(unittest.TestCase): [12, 13, 13, 14, 13, 13, 14, 13, 13, 14, 13, 13, 14, 13, 13, 14]) - # COM: comment - # Registration - self.assertEqual(c.segment[4].rcme, glymur.core.RCME_ISO_8859_1) - # Comment value - self.assertEqual(c.segment[4].ccme.decode('latin-1'), - "ClearCanvas DICOM OpenJPEG") + pargs = (RCME_ISO_8859_1, "ClearCanvas DICOM OpenJPEG".encode()) + self.verifyCMEsegment(c.segment[4], CMEsegment(*pargs)) def test_NR_123_j2c_dump(self): jfile = opj_data_file('input/nonregression/123.j2c') @@ -4294,26 +2437,13 @@ class TestSuiteDump(unittest.TestCase): expected = ['SOC', 'SIZ', 'COD', 'QCD'] self.assertEqual(ids, expected) - # SIZ: Image and tile size - # Profile: - self.assertEqual(c.segment[1].rsiz, 0) - # Reference grid size - self.assertEqual(c.segment[1].xsiz, 1800) - self.assertEqual(c.segment[1].ysiz, 1800) - # Reference grid offset - self.assertEqual((c.segment[1].xosiz, c.segment[1].yosiz), (0, 0)) - # Tile size - self.assertEqual((c.segment[1].xtsiz, c.segment[1].ytsiz), - (1800, 1800)) - # Tile offset - self.assertEqual((c.segment[1].xtosiz, c.segment[1].ytosiz), (0, 0)) - # bitdepth - self.assertEqual(c.segment[1].bitdepth, (16,)) - # signed - self.assertEqual(c.segment[1].signed, (False,)) - # subsampling - self.assertEqual(list(zip(c.segment[1].xrsiz, c.segment[1].yrsiz)), - [(1, 1)] * 1) + kwargs = {'rsiz': 0, 'xysiz': (1800, 1800), 'xyosiz': (0, 0), + 'xytsiz': (1800, 1800), 'xytosiz': (0, 0), + 'bitdepth': (16,), + 'signed': (False,), + 'xyrsiz': [(1,), (1,)]} + self.verifySizSegment(c.segment[1], + glymur.codestream.SIZsegment(**kwargs)) # COD: Coding style default self.assertFalse(c.segment[2].scod & 2) # no sop @@ -4322,20 +2452,9 @@ class TestSuiteDump(unittest.TestCase): self.assertEqual(c.segment[2].layers, 1) # layers = 1 self.assertEqual(c.segment[2].spcod[3], 1) # mct self.assertEqual(c.segment[2].spcod[4], 11) # level - self.assertEqual(tuple(c.segment[2].code_block_size), - (64, 64)) # cblk - # Selective arithmetic coding bypass - self.assertFalse(c.segment[2].spcod[7] & 0x01) - # Reset context probabilities - self.assertFalse(c.segment[2].spcod[7] & 0x02) - # Termination on each coding pass - self.assertFalse(c.segment[2].spcod[7] & 0x04) - # Vertically causal context - self.assertFalse(c.segment[2].spcod[7] & 0x08) - # Predictable termination - self.assertFalse(c.segment[2].spcod[7] & 0x0010) - # Segmentation symbols - self.assertFalse(c.segment[2].spcod[7] & 0x0020) + self.assertEqual(tuple(c.segment[2].code_block_size), (64, 64)) + self.verify_codeblock_style(c.segment[2].spcod[7], + [False, False, False, False, False, False]) self.assertEqual(c.segment[2].spcod[8], glymur.core.WAVELET_XFORM_5X3_REVERSIBLE) self.assertEqual(len(c.segment[2].spcod), 9) @@ -4356,26 +2475,13 @@ class TestSuiteDump(unittest.TestCase): expected = ['SOC', 'SIZ', 'COD', 'QCD'] self.assertEqual(ids, expected) - # SIZ: Image and tile size - # Profile: - self.assertEqual(c.segment[1].rsiz, 0) - # Reference grid size - self.assertEqual(c.segment[1].xsiz, 1800) - self.assertEqual(c.segment[1].ysiz, 1800) - # Reference grid offset - self.assertEqual((c.segment[1].xosiz, c.segment[1].yosiz), (0, 0)) - # Tile size - self.assertEqual((c.segment[1].xtsiz, c.segment[1].ytsiz), - (1800, 1800)) - # Tile offset - self.assertEqual((c.segment[1].xtosiz, c.segment[1].ytosiz), (0, 0)) - # bitdepth - self.assertEqual(c.segment[1].bitdepth, (16,)) - # signed - self.assertEqual(c.segment[1].signed, (False,)) - # subsampling - self.assertEqual(list(zip(c.segment[1].xrsiz, c.segment[1].yrsiz)), - [(1, 1)] * 1) + kwargs = {'rsiz': 0, 'xysiz': (1800, 1800), 'xyosiz': (0, 0), + 'xytsiz': (1800, 1800), 'xytosiz': (0, 0), + 'bitdepth': (16,), + 'signed': (False,), + 'xyrsiz': [(1,), (1,)]} + self.verifySizSegment(c.segment[1], + glymur.codestream.SIZsegment(**kwargs)) # COD: Coding style default self.assertFalse(c.segment[2].scod & 2) # no sop @@ -4384,20 +2490,9 @@ class TestSuiteDump(unittest.TestCase): self.assertEqual(c.segment[2].layers, 1) # layers = 1 self.assertEqual(c.segment[2].spcod[3], 1) # mct self.assertEqual(c.segment[2].spcod[4], 11) # level - self.assertEqual(tuple(c.segment[2].code_block_size), - (64, 64)) # cblk - # Selective arithmetic coding bypass - self.assertFalse(c.segment[2].spcod[7] & 0x01) - # Reset context probabilities - self.assertFalse(c.segment[2].spcod[7] & 0x02) - # Termination on each coding pass - self.assertFalse(c.segment[2].spcod[7] & 0x04) - # Vertically causal context - self.assertFalse(c.segment[2].spcod[7] & 0x08) - # Predictable termination - self.assertFalse(c.segment[2].spcod[7] & 0x0010) - # Segmentation symbols - self.assertFalse(c.segment[2].spcod[7] & 0x0020) + self.assertEqual(tuple(c.segment[2].code_block_size), (64, 64)) + self.verify_codeblock_style(c.segment[2].spcod[7], + [False, False, False, False, False, False]) self.assertEqual(c.segment[2].spcod[8], glymur.core.WAVELET_XFORM_5X3_REVERSIBLE) self.assertEqual(len(c.segment[2].spcod), 9) @@ -4418,26 +2513,13 @@ class TestSuiteDump(unittest.TestCase): expected = ['SOC', 'SIZ', 'COD', 'QCD', 'CME'] self.assertEqual(ids, expected) - # SIZ: Image and tile size - # Profile: - self.assertEqual(c.segment[1].rsiz, 0) - # Reference grid size - self.assertEqual(c.segment[1].xsiz, 2048) - self.assertEqual(c.segment[1].ysiz, 1556) - # Reference grid offset - self.assertEqual((c.segment[1].xosiz, c.segment[1].yosiz), (0, 0)) - # Tile size - self.assertEqual((c.segment[1].xtsiz, c.segment[1].ytsiz), - (2048, 1556)) - # Tile offset - self.assertEqual((c.segment[1].xtosiz, c.segment[1].ytosiz), (0, 0)) - # bitdepth - self.assertEqual(c.segment[1].bitdepth, (12, 12, 12)) - # signed - self.assertEqual(c.segment[1].signed, (False, False, False)) - # subsampling - self.assertEqual(list(zip(c.segment[1].xrsiz, c.segment[1].yrsiz)), - [(1, 1)] * 3) + kwargs = {'rsiz': 0, 'xysiz': (2048, 1556), 'xyosiz': (0, 0), + 'xytsiz': (2048, 1556), 'xytosiz': (0, 0), + 'bitdepth': (12, 12, 12), + 'signed': (False, False, False), + 'xyrsiz': [(1, 1, 1), (1, 1, 1)]} + self.verifySizSegment(c.segment[1], + glymur.codestream.SIZsegment(**kwargs)) # COD: Coding style default self.assertFalse(c.segment[2].scod & 2) # no sop @@ -4446,20 +2528,9 @@ class TestSuiteDump(unittest.TestCase): self.assertEqual(c.segment[2].layers, 2) # layers = 2 self.assertEqual(c.segment[2].spcod[3], 1) # mct self.assertEqual(c.segment[2].spcod[4], 5) # level - self.assertEqual(tuple(c.segment[2].code_block_size), - (32, 32)) # cblk - # Selective arithmetic coding bypass - self.assertFalse(c.segment[2].spcod[7] & 0x01) - # Reset context probabilities - self.assertFalse(c.segment[2].spcod[7] & 0x02) - # Termination on each coding pass - self.assertFalse(c.segment[2].spcod[7] & 0x04) - # Vertically causal context - self.assertFalse(c.segment[2].spcod[7] & 0x08) - # Predictable termination - self.assertFalse(c.segment[2].spcod[7] & 0x0010) - # Segmentation symbols - self.assertFalse(c.segment[2].spcod[7] & 0x0020) + self.assertEqual(tuple(c.segment[2].code_block_size), (32, 32)) + self.verify_codeblock_style(c.segment[2].spcod[7], + [False, False, False, False, False, False]) self.assertEqual(c.segment[2].spcod[8], glymur.core.WAVELET_XFORM_9X7_IRREVERSIBLE) self.assertEqual(c.segment[2].precinct_size, @@ -4473,12 +2544,8 @@ class TestSuiteDump(unittest.TestCase): [13, 12, 12, 12, 12, 12, 12, 13, 13, 13, 13, 13, 13, 13, 13, 13]) - # COM: comment - # Registration - self.assertEqual(c.segment[4].rcme, glymur.core.RCME_ISO_8859_1) - # Comment value - self.assertEqual(c.segment[4].ccme.decode('latin-1'), - "DCP-Werkstatt") + pargs = (RCME_ISO_8859_1, "DCP-Werkstatt".encode()) + self.verifyCMEsegment(c.segment[4], CMEsegment(*pargs)) def test_NR_issue104_jpxstream_dump(self): jfile = opj_data_file('input/nonregression/issue104_jpxstream.jp2') @@ -4490,38 +2557,23 @@ class TestSuiteDump(unittest.TestCase): ids = [box.box_id for box in jp2.box[3].box] self.assertEqual(ids, ['ihdr', 'colr', 'pclr', 'cmap']) - # Signature box. Check for corruption. - self.assertEqual(jp2.box[0].signature, (13, 10, 135, 10)) - - # File type box. - self.assertEqual(jp2.box[1].brand, 'jp2 ') - self.assertEqual(jp2.box[1].minor_version, 0) - self.assertEqual(jp2.box[1].compatibility_list[0], 'jp2 ') - self.assertEqual(jp2.box[1].compatibility_list[1], 'jpxb') - self.assertEqual(jp2.box[1].compatibility_list[2], 'jpx ') + self.verifySignatureBox(jp2.box[0]) + self.verify_filetype_box(jp2.box[1], + FileTypeBox(compatibility_list=['jp2 ', + 'jpxb', + 'jpx '])) # Reader requirements talk. # unrestricted jpeg 2000 part 1 self.assertTrue(5 in jp2.box[2].standard_flag) - # Jp2 Header - # Image header - self.assertEqual(jp2.box[3].box[0].height, 203) - self.assertEqual(jp2.box[3].box[0].width, 479) - self.assertEqual(jp2.box[3].box[0].num_components, 1) - self.assertEqual(jp2.box[3].box[0].bits_per_component, 8) - self.assertEqual(jp2.box[3].box[0].signed, False) - self.assertEqual(jp2.box[3].box[0].compression, 7) # wavelet - self.assertEqual(jp2.box[3].box[0].colorspace_unknown, True) - self.assertEqual(jp2.box[3].box[0].ip_provided, False) + ihdr = glymur.jp2box.ImageHeaderBox(203, 479, colorspace_unknown=True) + self.verifyImageHeaderBox(jp2.box[3].box[0], ihdr) - # Jp2 Header - # Colour specification - self.assertEqual(jp2.box[3].box[1].method, - glymur.core.ENUMERATED_COLORSPACE) - self.assertEqual(jp2.box[3].box[1].precedence, 2) - self.assertEqual(jp2.box[3].box[1].approximation, 1) # exact - self.assertEqual(jp2.box[3].box[1].colorspace, glymur.core.SRGB) + colr = glymur.jp2box.ColourSpecificationBox(colorspace=SRGB, + approximation=1, + precedence=2) + self.verifyColourSpecificationBox(jp2.box[3].box[1], colr) # Jp2 Header # Palette box. @@ -4533,31 +2585,19 @@ class TestSuiteDump(unittest.TestCase): self.assertEqual(jp2.box[3].box[3].mapping_type, (1, 1, 1)) self.assertEqual(jp2.box[3].box[3].palette_index, (0, 1, 2)) - c = jp2.box[4].main_header + c = jp2.box[4].codestream ids = [x.marker_id for x in c.segment] expected = ['SOC', 'SIZ', 'COD', 'QCD'] self.assertEqual(ids, expected) - # SIZ: Image and tile size - # Profile: - self.assertEqual(c.segment[1].rsiz, 0) - # Reference grid size - self.assertEqual(c.segment[1].xsiz, 479) - self.assertEqual(c.segment[1].ysiz, 203) - # Reference grid offset - self.assertEqual((c.segment[1].xosiz, c.segment[1].yosiz), (0, 0)) - # Tile size - self.assertEqual((c.segment[1].xtsiz, c.segment[1].ytsiz), (256, 203)) - # Tile offset - self.assertEqual((c.segment[1].xtosiz, c.segment[1].ytosiz), (0, 0)) - # bitdepth - self.assertEqual(c.segment[1].bitdepth, (8,)) - # signed - self.assertEqual(c.segment[1].signed, (False,)) - # subsampling - self.assertEqual(list(zip(c.segment[1].xrsiz, c.segment[1].yrsiz)), - [(1, 1)]) + kwargs = {'rsiz': 0, 'xysiz': (479, 203), 'xyosiz': (0, 0), + 'xytsiz': (256, 203), 'xytosiz': (0, 0), + 'bitdepth': (8,), + 'signed': (False,), + 'xyrsiz': [(1,), (1,)]} + self.verifySizSegment(c.segment[1], + glymur.codestream.SIZsegment(**kwargs)) # COD: Coding style default self.assertFalse(c.segment[2].scod & 2) # no sop @@ -4566,20 +2606,9 @@ class TestSuiteDump(unittest.TestCase): self.assertEqual(c.segment[2].layers, 1) # layers = 1 self.assertEqual(c.segment[2].spcod[3], 0) # mct self.assertEqual(c.segment[2].spcod[4], 5) # level - self.assertEqual(tuple(c.segment[2].code_block_size), - (32, 32)) # cblk - # Selective arithmetic coding bypass - self.assertFalse(c.segment[2].spcod[7] & 0x01) - # Reset context probabilities - self.assertFalse(c.segment[2].spcod[7] & 0x02) - # Termination on each coding pass - self.assertFalse(c.segment[2].spcod[7] & 0x04) - # Vertically causal context - self.assertFalse(c.segment[2].spcod[7] & 0x08) - # Predictable termination - self.assertFalse(c.segment[2].spcod[7] & 0x0010) - # Segmentation symbols - self.assertFalse(c.segment[2].spcod[7] & 0x0020) + self.assertEqual(tuple(c.segment[2].code_block_size), (32, 32)) + self.verify_codeblock_style(c.segment[2].spcod[7], + [False, False, False, False, False, False]) self.assertEqual(c.segment[2].spcod[8], glymur.core.WAVELET_XFORM_5X3_REVERSIBLE) self.assertEqual(len(c.segment[2].spcod), 9) @@ -4590,105 +2619,6 @@ class TestSuiteDump(unittest.TestCase): self.assertEqual(c.segment[3].mantissa, [0] * 16) self.assertEqual(c.segment[3].exponent, [8] + [9, 9, 10] * 5) - def test_NR_issue188_beach_64bitsbox(self): - lst = ['input', 'nonregression', 'issue188_beach_64bitsbox.jp2'] - jfile = opj_data_file('/'.join(lst)) - with warnings.catch_warnings(): - # There's a warning for an unknown box. We explicitly test for - # that down below. - warnings.simplefilter("ignore") - jp2 = Jp2k(jfile) - - ids = [box.box_id for box in jp2.box] - self.assertEqual(ids, ['jP ', 'ftyp', 'jp2h', b'XML ', 'jp2c']) - - ids = [box.box_id for box in jp2.box[2].box] - self.assertEqual(ids, ['ihdr', 'colr']) - - # Signature box. Check for corruption. - self.assertEqual(jp2.box[0].signature, (13, 10, 135, 10)) - - # File type box. - self.assertEqual(jp2.box[1].brand, 'jp2 ') - self.assertEqual(jp2.box[1].minor_version, 0) - self.assertEqual(jp2.box[1].compatibility_list[0], 'jp2 ') - - # Jp2 Header - # Image header - self.assertEqual(jp2.box[2].box[0].height, 200) - self.assertEqual(jp2.box[2].box[0].width, 200) - self.assertEqual(jp2.box[2].box[0].num_components, 3) - self.assertEqual(jp2.box[2].box[0].bits_per_component, 8) - self.assertEqual(jp2.box[2].box[0].signed, False) - self.assertEqual(jp2.box[2].box[0].compression, 7) # wavelet - self.assertEqual(jp2.box[2].box[0].colorspace_unknown, True) - self.assertEqual(jp2.box[2].box[0].ip_provided, False) - - # Jp2 Header - # Colour specification - self.assertEqual(jp2.box[2].box[1].method, - glymur.core.ENUMERATED_COLORSPACE) - self.assertEqual(jp2.box[2].box[1].precedence, 0) - self.assertEqual(jp2.box[2].box[1].approximation, 0) - self.assertEqual(jp2.box[2].box[1].colorspace, glymur.core.SRGB) - - # Skip the 4th box, it is uknown. - - c = jp2.box[4].main_header - - ids = [x.marker_id for x in c.segment] - expected = ['SOC', 'SIZ', 'COD', 'QCD', 'CME', 'CME'] - self.assertEqual(ids, expected) - - # SIZ: Image and tile size - # Profile: - self.assertEqual(c.segment[1].rsiz, 0) - # Reference grid size - self.assertEqual(c.segment[1].xsiz, 200) - self.assertEqual(c.segment[1].ysiz, 200) - # Reference grid offset - self.assertEqual((c.segment[1].xosiz, c.segment[1].yosiz), (0, 0)) - # Tile size - self.assertEqual((c.segment[1].xtsiz, c.segment[1].ytsiz), (200, 200)) - # Tile offset - self.assertEqual((c.segment[1].xtosiz, c.segment[1].ytosiz), (0, 0)) - # bitdepth - self.assertEqual(c.segment[1].bitdepth, (8, 8, 8)) - # signed - self.assertEqual(c.segment[1].signed, (False, False, False)) - # subsampling - self.assertEqual(list(zip(c.segment[1].xrsiz, c.segment[1].yrsiz)), - [(1, 1)] * 3) - - # COD: Coding style default - self.assertFalse(c.segment[2].scod & 2) # no sop - self.assertFalse(c.segment[2].scod & 4) # no eph - self.assertEqual(c.segment[2].spcod[0], glymur.core.LRCP) - self.assertEqual(c.segment[2].layers, 1) # layers = 1 - self.assertEqual(c.segment[2].spcod[3], 1) # mct - self.assertEqual(c.segment[2].spcod[4], 5) # level - self.assertEqual(tuple(c.segment[2].code_block_size), - (64, 64)) # cblk - # Selective arithmetic coding bypass - self.assertFalse(c.segment[2].spcod[7] & 0x01) - # Reset context probabilities - self.assertFalse(c.segment[2].spcod[7] & 0x02) - # Termination on each coding pass - self.assertFalse(c.segment[2].spcod[7] & 0x04) - # Vertically causal context - self.assertFalse(c.segment[2].spcod[7] & 0x08) - # Predictable termination - self.assertFalse(c.segment[2].spcod[7] & 0x0010) - # Segmentation symbols - self.assertFalse(c.segment[2].spcod[7] & 0x0020) - self.assertEqual(c.segment[2].spcod[8], - glymur.core.WAVELET_XFORM_9X7_IRREVERSIBLE) - self.assertEqual(len(c.segment[2].spcod), 9) - - # QCD: Quantization default - self.assertEqual(c.segment[3].sqcd & 0x1f, 2) - self.assertEqual(c.segment[3].guard_bits, 1) - def test_NR_issue206_image_000_dump(self): jfile = opj_data_file('input/nonregression/issue206_image-000.jp2') jp2 = Jp2k(jfile) @@ -4699,64 +2629,39 @@ class TestSuiteDump(unittest.TestCase): ids = [box.box_id for box in jp2.box[3].box] self.assertEqual(ids, ['ihdr', 'colr']) - # Signature box. Check for corruption. - self.assertEqual(jp2.box[0].signature, (13, 10, 135, 10)) - - # File type box. - self.assertEqual(jp2.box[1].brand, 'jp2 ') - self.assertEqual(jp2.box[1].minor_version, 0) - self.assertEqual(jp2.box[1].compatibility_list[0], 'jp2 ') - self.assertEqual(jp2.box[1].compatibility_list[1], 'jpxb') - self.assertEqual(jp2.box[1].compatibility_list[2], 'jpx ') + self.verifySignatureBox(jp2.box[0]) + self.verify_filetype_box(jp2.box[1], + FileTypeBox(compatibility_list=['jp2 ', + 'jpxb', + 'jpx '])) # Reader requirements talk. # unrestricted jpeg 2000 part 1 self.assertTrue(5 in jp2.box[2].standard_flag) - # Jp2 Header - # Image header - self.assertEqual(jp2.box[3].box[0].height, 326) - self.assertEqual(jp2.box[3].box[0].width, 431) - self.assertEqual(jp2.box[3].box[0].num_components, 3) - self.assertEqual(jp2.box[3].box[0].bits_per_component, 8) - self.assertEqual(jp2.box[3].box[0].signed, False) - self.assertEqual(jp2.box[3].box[0].compression, 7) # wavelet - self.assertEqual(jp2.box[3].box[0].colorspace_unknown, True) - self.assertEqual(jp2.box[3].box[0].ip_provided, False) + ihdr = glymur.jp2box.ImageHeaderBox(326, 431, + num_components=3, + colorspace_unknown=True) + self.verifyImageHeaderBox(jp2.box[3].box[0], ihdr) - # Jp2 Header - # Colour specification - self.assertEqual(jp2.box[3].box[1].method, - glymur.core.ENUMERATED_COLORSPACE) - self.assertEqual(jp2.box[3].box[1].precedence, 2) - self.assertEqual(jp2.box[3].box[1].approximation, 1) # JPX exact - self.assertEqual(jp2.box[3].box[1].colorspace, glymur.core.SRGB) + colr = glymur.jp2box.ColourSpecificationBox(colorspace=SRGB, + approximation=1, + precedence=2) + self.verifyColourSpecificationBox(jp2.box[3].box[1], colr) - c = jp2.box[4].main_header + c = jp2.box[4].codestream ids = [x.marker_id for x in c.segment] expected = ['SOC', 'SIZ', 'COD', 'QCD'] self.assertEqual(ids, expected) - # SIZ: Image and tile size - # Profile: - self.assertEqual(c.segment[1].rsiz, 0) - # Reference grid size - self.assertEqual(c.segment[1].xsiz, 431) - self.assertEqual(c.segment[1].ysiz, 326) - # Reference grid offset - self.assertEqual((c.segment[1].xosiz, c.segment[1].yosiz), (0, 0)) - # Tile size - self.assertEqual((c.segment[1].xtsiz, c.segment[1].ytsiz), (256, 256)) - # Tile offset - self.assertEqual((c.segment[1].xtosiz, c.segment[1].ytosiz), (0, 0)) - # bitdepth - self.assertEqual(c.segment[1].bitdepth, (8, 8, 8)) - # signed - self.assertEqual(c.segment[1].signed, (False, False, False)) - # subsampling - self.assertEqual(list(zip(c.segment[1].xrsiz, c.segment[1].yrsiz)), - [(1, 1)] * 3) + kwargs = {'rsiz': 0, 'xysiz': (431, 326), 'xyosiz': (0, 0), + 'xytsiz': (256, 256), 'xytosiz': (0, 0), + 'bitdepth': (8, 8, 8), + 'signed': (False, False, False), + 'xyrsiz': [(1, 1, 1), (1, 1, 1)]} + self.verifySizSegment(c.segment[1], + glymur.codestream.SIZsegment(**kwargs)) # COD: Coding style default self.assertFalse(c.segment[2].scod & 2) # no sop @@ -4765,20 +2670,9 @@ class TestSuiteDump(unittest.TestCase): self.assertEqual(c.segment[2].layers, 1) # layers = 1 self.assertEqual(c.segment[2].spcod[3], 1) # mct self.assertEqual(c.segment[2].spcod[4], 5) # level - self.assertEqual(tuple(c.segment[2].code_block_size), - (32, 32)) # cblk - # Selective arithmetic coding bypass - self.assertFalse(c.segment[2].spcod[7] & 0x01) - # Reset context probabilities - self.assertFalse(c.segment[2].spcod[7] & 0x02) - # Termination on each coding pass - self.assertFalse(c.segment[2].spcod[7] & 0x04) - # Vertically causal context - self.assertFalse(c.segment[2].spcod[7] & 0x08) - # Predictable termination - self.assertFalse(c.segment[2].spcod[7] & 0x0010) - # Segmentation symbols - self.assertFalse(c.segment[2].spcod[7] & 0x0020) + self.assertEqual(tuple(c.segment[2].code_block_size), (32, 32)) + self.verify_codeblock_style(c.segment[2].spcod[7], + [False, False, False, False, False, False]) self.assertEqual(c.segment[2].spcod[8], glymur.core.WAVELET_XFORM_9X7_IRREVERSIBLE) self.assertEqual(len(c.segment[2].spcod), 9) @@ -4802,32 +2696,15 @@ class TestSuiteDump(unittest.TestCase): ids = [box.box_id for box in jp2.box[2].box[3].box] self.assertEqual(ids, ['resd']) - # Signature box. Check for corruption. - self.assertEqual(jp2.box[0].signature, (13, 10, 135, 10)) + self.verifySignatureBox(jp2.box[0]) + self.verify_filetype_box(jp2.box[1], FileTypeBox()) - # File type box. - self.assertEqual(jp2.box[1].brand, 'jp2 ') - self.assertEqual(jp2.box[1].minor_version, 0) - self.assertEqual(jp2.box[1].compatibility_list[0], 'jp2 ') + ihdr = glymur.jp2box.ImageHeaderBox(135, 135, num_components=2, + colorspace_unknown=True) + self.verifyImageHeaderBox(jp2.box[2].box[0], ihdr) - # Jp2 Header - # Image header - self.assertEqual(jp2.box[2].box[0].height, 135) - self.assertEqual(jp2.box[2].box[0].width, 135) - self.assertEqual(jp2.box[2].box[0].num_components, 2) - self.assertEqual(jp2.box[2].box[0].bits_per_component, 8) - self.assertEqual(jp2.box[2].box[0].signed, False) - self.assertEqual(jp2.box[2].box[0].compression, 7) # wavelet - self.assertEqual(jp2.box[2].box[0].colorspace_unknown, True) - self.assertEqual(jp2.box[2].box[0].ip_provided, False) - - # Jp2 Header - # Colour specification - self.assertEqual(jp2.box[2].box[1].method, - glymur.core.ENUMERATED_COLORSPACE) - self.assertEqual(jp2.box[2].box[1].precedence, 0) - self.assertEqual(jp2.box[2].box[1].approximation, 0) # JP2 - self.assertEqual(jp2.box[2].box[1].colorspace, glymur.core.GREYSCALE) + colr = glymur.jp2box.ColourSpecificationBox(colorspace=GREYSCALE) + self.verifyColourSpecificationBox(jp2.box[2].box[1], colr) # Jp2 Header # Channel Definition @@ -4835,31 +2712,19 @@ class TestSuiteDump(unittest.TestCase): self.assertEqual(jp2.box[2].box[2].channel_type, (0, 1)) # opacity self.assertEqual(jp2.box[2].box[2].association, (0, 0)) # both main - c = jp2.box[3].main_header + c = jp2.box[3].codestream ids = [x.marker_id for x in c.segment] expected = ['SOC', 'SIZ', 'COD', 'QCD', 'CME'] self.assertEqual(ids, expected) - # SIZ: Image and tile size - # Profile: - self.assertEqual(c.segment[1].rsiz, 0) - # Reference grid size - self.assertEqual(c.segment[1].xsiz, 135) - self.assertEqual(c.segment[1].ysiz, 135) - # Reference grid offset - self.assertEqual((c.segment[1].xosiz, c.segment[1].yosiz), (0, 0)) - # Tile size - self.assertEqual((c.segment[1].xtsiz, c.segment[1].ytsiz), (135, 135)) - # Tile offset - self.assertEqual((c.segment[1].xtosiz, c.segment[1].ytosiz), (0, 0)) - # bitdepth - self.assertEqual(c.segment[1].bitdepth, (8, 8)) - # signed - self.assertEqual(c.segment[1].signed, (False, False)) - # subsampling - self.assertEqual(list(zip(c.segment[1].xrsiz, c.segment[1].yrsiz)), - [(1, 1)] * 2) + kwargs = {'rsiz': 0, 'xysiz': (135, 135), 'xyosiz': (0, 0), + 'xytsiz': (135, 135), 'xytosiz': (0, 0), + 'bitdepth': (8, 8), + 'signed': (False, False), + 'xyrsiz': [(1, 1), (1, 1)]} + self.verifySizSegment(c.segment[1], + glymur.codestream.SIZsegment(**kwargs)) # COD: Coding style default self.assertFalse(c.segment[2].scod & 2) # no sop @@ -4870,18 +2735,8 @@ class TestSuiteDump(unittest.TestCase): self.assertEqual(c.segment[2].spcod[4], 5) # level self.assertEqual(tuple(c.segment[2].code_block_size), (64, 64)) # cblk - # Selective arithmetic coding bypass - self.assertFalse(c.segment[2].spcod[7] & 0x01) - # Reset context probabilities - self.assertFalse(c.segment[2].spcod[7] & 0x02) - # Termination on each coding pass - self.assertFalse(c.segment[2].spcod[7] & 0x04) - # Vertically causal context - self.assertFalse(c.segment[2].spcod[7] & 0x08) - # Predictable termination - self.assertFalse(c.segment[2].spcod[7] & 0x0010) - # Segmentation symbols - self.assertFalse(c.segment[2].spcod[7] & 0x0020) + self.verify_codeblock_style(c.segment[2].spcod[7], + [False, False, False, False, False, False]) self.assertEqual(c.segment[2].spcod[8], glymur.core.WAVELET_XFORM_9X7_IRREVERSIBLE) self.assertEqual(len(c.segment[2].spcod), 9) @@ -4895,12 +2750,8 @@ class TestSuiteDump(unittest.TestCase): self.assertEqual(c.segment[3].exponent, [14] * 4 + [13] * 3 + [12] * 3 + [10] * 6) - # COM: comment - # Registration - self.assertEqual(c.segment[4].rcme, glymur.core.RCME_ISO_8859_1) - # Comment value - self.assertEqual(c.segment[4].ccme.decode('latin-1'), - "Kakadu-v5.2.1") + pargs = (RCME_ISO_8859_1, "Kakadu-v5.2.1".encode()) + self.verifyCMEsegment(c.segment[4], CMEsegment(*pargs)) def test_NR_mem_b2b86b74_2753_dump(self): jfile = opj_data_file('input/nonregression/mem-b2b86b74-2753.jp2') @@ -4912,38 +2763,26 @@ class TestSuiteDump(unittest.TestCase): ids = [box.box_id for box in jp2.box[3].box] self.assertEqual(ids, ['ihdr', 'colr', 'pclr', 'cmap']) - # Signature box. Check for corruption. - self.assertEqual(jp2.box[0].signature, (13, 10, 135, 10)) - - # File type box. - self.assertEqual(jp2.box[1].brand, 'jp2 ') - self.assertEqual(jp2.box[1].minor_version, 0) - self.assertEqual(jp2.box[1].compatibility_list[0], 'jp2 ') - self.assertEqual(jp2.box[1].compatibility_list[1], 'jpxb') - self.assertEqual(jp2.box[1].compatibility_list[2], 'jpx ') + self.verifySignatureBox(jp2.box[0]) + self.verify_filetype_box(jp2.box[1], + FileTypeBox(compatibility_list=['jp2 ', + 'jpxb', + 'jpx '])) # Reader requirements talk. # unrestricted jpeg 2000 part 1 self.assertTrue(5 in jp2.box[2].standard_flag) - # Jp2 Header - # Image header - self.assertEqual(jp2.box[3].box[0].height, 46) - self.assertEqual(jp2.box[3].box[0].width, 124) - self.assertEqual(jp2.box[3].box[0].num_components, 1) - self.assertEqual(jp2.box[3].box[0].bits_per_component, 4) - self.assertEqual(jp2.box[3].box[0].signed, False) - self.assertEqual(jp2.box[3].box[0].compression, 7) # wavelet - self.assertEqual(jp2.box[3].box[0].colorspace_unknown, True) - self.assertEqual(jp2.box[3].box[0].ip_provided, False) + ihdr = glymur.jp2box.ImageHeaderBox(46, 124, bits_per_component=4, + colorspace_unknown=True) + self.verifyImageHeaderBox(jp2.box[3].box[0], ihdr) - # Jp2 Header - # Colour specification - self.assertEqual(jp2.box[3].box[1].method, - glymur.core.ENUMERATED_COLORSPACE) - self.assertEqual(jp2.box[3].box[1].precedence, 2) - self.assertEqual(jp2.box[3].box[1].approximation, 1) # JPX exact - self.assertEqual(jp2.box[3].box[1].colorspace, glymur.core.SRGB) + method = ENUMERATED_COLORSPACE + colr = glymur.jp2box.ColourSpecificationBox(colorspace=SRGB, + method=method, + approximation=1, + precedence=2) + self.verifyColourSpecificationBox(jp2.box[3].box[1], colr) # Jp2 Header # Palette box. @@ -4956,31 +2795,19 @@ class TestSuiteDump(unittest.TestCase): self.assertEqual(jp2.box[3].box[3].mapping_type, (1, 1, 1)) self.assertEqual(jp2.box[3].box[3].palette_index, (0, 1, 2)) - c = jp2.box[4].main_header + c = jp2.box[4].codestream ids = [x.marker_id for x in c.segment] expected = ['SOC', 'SIZ', 'COD', 'QCD'] self.assertEqual(ids, expected) - # SIZ: Image and tile size - # Profile: - self.assertEqual(c.segment[1].rsiz, 0) - # Reference grid size - self.assertEqual(c.segment[1].xsiz, 124) - self.assertEqual(c.segment[1].ysiz, 46) - # Reference grid offset - self.assertEqual((c.segment[1].xosiz, c.segment[1].yosiz), (0, 0)) - # Tile size - self.assertEqual((c.segment[1].xtsiz, c.segment[1].ytsiz), (124, 46)) - # Tile offset - self.assertEqual((c.segment[1].xtosiz, c.segment[1].ytosiz), (0, 0)) - # bitdepth - self.assertEqual(c.segment[1].bitdepth, (4,)) - # signed - self.assertEqual(c.segment[1].signed, (False,)) - # subsampling - self.assertEqual(list(zip(c.segment[1].xrsiz, c.segment[1].yrsiz)), - [(1, 1)]) + kwargs = {'rsiz': 0, 'xysiz': (124, 46), 'xyosiz': (0, 0), + 'xytsiz': (124, 46), 'xytosiz': (0, 0), + 'bitdepth': (4,), + 'signed': (False,), + 'xyrsiz': [(1,), (1,)]} + self.verifySizSegment(c.segment[1], + glymur.codestream.SIZsegment(**kwargs)) # COD: Coding style default self.assertFalse(c.segment[2].scod & 2) # no sop @@ -4991,18 +2818,8 @@ class TestSuiteDump(unittest.TestCase): self.assertEqual(c.segment[2].spcod[4], 5) # level self.assertEqual(tuple(c.segment[2].code_block_size), (32, 32)) # cblk - # Selective arithmetic coding bypass - self.assertFalse(c.segment[2].spcod[7] & 0x01) - # Reset context probabilities - self.assertFalse(c.segment[2].spcod[7] & 0x02) - # Termination on each coding pass - self.assertFalse(c.segment[2].spcod[7] & 0x04) - # Vertically causal context - self.assertFalse(c.segment[2].spcod[7] & 0x08) - # Predictable termination - self.assertFalse(c.segment[2].spcod[7] & 0x0010) - # Segmentation symbols - self.assertFalse(c.segment[2].spcod[7] & 0x0020) + self.verify_codeblock_style(c.segment[2].spcod[7], + [False, False, False, False, False, False]) self.assertEqual(c.segment[2].spcod[8], glymur.core.WAVELET_XFORM_5X3_REVERSIBLE) self.assertEqual(len(c.segment[2].spcod), 9) @@ -5023,58 +2840,28 @@ class TestSuiteDump(unittest.TestCase): ids = [box.box_id for box in jp2.box[2].box] self.assertEqual(ids, ['ihdr', 'colr']) - # Signature box. Check for corruption. - self.assertEqual(jp2.box[0].signature, (13, 10, 135, 10)) + self.verifySignatureBox(jp2.box[0]) + self.verify_filetype_box(jp2.box[1], FileTypeBox()) - # File type box. - self.assertEqual(jp2.box[1].brand, 'jp2 ') - self.assertEqual(jp2.box[1].minor_version, 0) - self.assertEqual(jp2.box[1].compatibility_list[0], 'jp2 ') + ihdr = glymur.jp2box.ImageHeaderBox(576, 766, num_components=3) + self.verifyImageHeaderBox(jp2.box[2].box[0], ihdr) - # Jp2 Header - # Image header - self.assertEqual(jp2.box[2].box[0].height, 576) - self.assertEqual(jp2.box[2].box[0].width, 766) - self.assertEqual(jp2.box[2].box[0].num_components, 3) - self.assertEqual(jp2.box[2].box[0].bits_per_component, 8) - self.assertEqual(jp2.box[2].box[0].signed, False) - self.assertEqual(jp2.box[2].box[0].compression, 7) # wavelet - self.assertEqual(jp2.box[2].box[0].colorspace_unknown, False) - self.assertEqual(jp2.box[2].box[0].ip_provided, False) + colr = glymur.jp2box.ColourSpecificationBox(colorspace=glymur.core.YCC) + self.verifyColourSpecificationBox(jp2.box[2].box[1], colr) - # Jp2 Header - # Colour specification - self.assertEqual(jp2.box[2].box[1].method, - glymur.core.ENUMERATED_COLORSPACE) - self.assertEqual(jp2.box[2].box[1].precedence, 0) - self.assertEqual(jp2.box[2].box[1].approximation, 0) # JP2 - self.assertEqual(jp2.box[2].box[1].colorspace, glymur.core.YCC) - - c = jp2.box[3].main_header + c = jp2.box[3].codestream ids = [x.marker_id for x in c.segment] expected = ['SOC', 'SIZ', 'COD', 'QCD', 'POD'] self.assertEqual(ids, expected) - # SIZ: Image and tile size - # Profile: - self.assertEqual(c.segment[1].rsiz, 0) - # Reference grid size - self.assertEqual(c.segment[1].xsiz, 766) - self.assertEqual(c.segment[1].ysiz, 576) - # Reference grid offset - self.assertEqual((c.segment[1].xosiz, c.segment[1].yosiz), (0, 0)) - # Tile size - self.assertEqual((c.segment[1].xtsiz, c.segment[1].ytsiz), (766, 576)) - # Tile offset - self.assertEqual((c.segment[1].xtosiz, c.segment[1].ytosiz), (0, 0)) - # bitdepth - self.assertEqual(c.segment[1].bitdepth, (8, 8, 8)) - # signed - self.assertEqual(c.segment[1].signed, (False, False, False)) - # subsampling - self.assertEqual(list(zip(c.segment[1].xrsiz, c.segment[1].yrsiz)), - [(1, 1), (2, 1), (2, 1)]) + kwargs = {'rsiz': 0, 'xysiz': (766, 576), 'xyosiz': (0, 0), + 'xytsiz': (766, 576), 'xytosiz': (0, 0), + 'bitdepth': (8, 8, 8), + 'signed': (False, False, False), + 'xyrsiz': [(1, 2, 2), (1, 1, 1)]} + self.verifySizSegment(c.segment[1], + glymur.codestream.SIZsegment(**kwargs)) # COD: Coding style default self.assertFalse(c.segment[2].scod & 2) # no sop @@ -5085,18 +2872,8 @@ class TestSuiteDump(unittest.TestCase): self.assertEqual(c.segment[2].spcod[4], 5) # level self.assertEqual(tuple(c.segment[2].code_block_size), (32, 128)) # cblk - # Selective arithmetic coding bypass - self.assertFalse(c.segment[2].spcod[7] & 0x01) - # Reset context probabilities - self.assertFalse(c.segment[2].spcod[7] & 0x02) - # Termination on each coding pass - self.assertFalse(c.segment[2].spcod[7] & 0x04) - # Vertically causal context - self.assertFalse(c.segment[2].spcod[7] & 0x08) - # Predictable termination - self.assertFalse(c.segment[2].spcod[7] & 0x0010) - # Segmentation symbols - self.assertFalse(c.segment[2].spcod[7] & 0x0020) + self.verify_codeblock_style(c.segment[2].spcod[7], + [False, False, False, False, False, False]) self.assertEqual(c.segment[2].spcod[8], glymur.core.WAVELET_XFORM_5X3_REVERSIBLE) self.assertEqual(len(c.segment[2].spcod), 9) @@ -5117,11 +2894,119 @@ class TestSuiteDump(unittest.TestCase): podvals = (glymur.core.LRCP, glymur.core.LRCP) self.assertEqual(c.segment[4].ppod, podvals) - def test_NR_orb_blue10_lin_jp2_dump(self): - jfile = opj_data_file('input/nonregression/orb-blue10-lin-jp2.jp2') + +@unittest.skipIf(WARNING_INFRASTRUCTURE_ISSUE, WARNING_INFRASTRUCTURE_MSG) +@unittest.skipIf(OPJ_DATA_ROOT is None, + "OPJ_DATA_ROOT environment variable not set") +class TestSuiteWarns(MetadataBase): + + @unittest.skipIf(re.match("1.5|2.0.0", glymur.version.openjpeg_version), + "Test not passing on 1.5, 2.0: not introduced until 2.x") + def test_NR_DEC_issue188_beach_64bitsbox_jp2_41_decode(self): + """ + Has an 'XML ' box instead of 'xml '. Just verify we can read it. + """ + relpath = 'input/nonregression/issue188_beach_64bitsbox.jp2' + jfile = opj_data_file(relpath) + with self.assertWarns(UserWarning): + Jp2k(jfile)[:] + self.assertTrue(True) + + def test_NR_broken4_jp2_dump(self): + jfile = opj_data_file('input/nonregression/broken4.jp2') with warnings.catch_warnings(): - # This file has an invalid ICC profile + # Suppress a warning, all we really care is parsing the entire + # file. warnings.simplefilter("ignore") + with self.assertWarns(UserWarning): + jp2 = Jp2k(jfile) + self.assertEqual(jp2.box[-1].codestream.segment[-1].marker_id, + 'QCC') + + def test_NR_broken2_jp2_dump(self): + """ + Invalid marker ID in the codestream. + """ + jfile = opj_data_file('input/nonregression/broken2.jp2') + with warnings.catch_warnings(): + # Suppress a warning, all we really care is parsing the entire + # file. + warnings.simplefilter("ignore") + with self.assertWarns(UserWarning): + # Invalid marker ID on codestream. + jp2 = Jp2k(jfile) + self.assertEqual(jp2.box[-1].codestream.segment[-1].marker_id, + 'QCC') + + def test_NR_file1_dump(self): + jfile = opj_data_file('input/conformance/file1.jp2') + with self.assertWarns(UserWarning): + # Bad compatibility list item. + jp2 = Jp2k(jfile) + + ids = [box.box_id for box in jp2.box] + self.assertEqual(ids, ['jP ', 'ftyp', 'xml ', 'jp2h', 'xml ', + 'jp2c']) + + ids = [box.box_id for box in jp2.box[3].box] + self.assertEqual(ids, ['ihdr', 'colr']) + + self.verifySignatureBox(jp2.box[0]) + self.verify_filetype_box(jp2.box[1], FileTypeBox()) + + # XML box + tags = [x.tag for x in jp2.box[2].xml.getroot()] + self.assertEqual(tags, + ['{http://www.jpeg.org/jpx/1.0/xml}' + + 'GENERAL_CREATION_INFO']) + + ihdr = glymur.jp2box.ImageHeaderBox(512, 768, num_components=3) + self.verifyImageHeaderBox(jp2.box[3].box[0], ihdr) + + colr = glymur.jp2box.ColourSpecificationBox(colorspace=SRGB, + approximation=1) + self.verifyColourSpecificationBox(jp2.box[3].box[1], colr) + + # XML box + tags = [x.tag for x in jp2.box[4].xml.getroot()] + self.assertEqual(tags, ['{http://www.jpeg.org/jpx/1.0/xml}CAPTION', + '{http://www.jpeg.org/jpx/1.0/xml}LOCATION', + '{http://www.jpeg.org/jpx/1.0/xml}EVENT']) + + def test_NR_file2_dump(self): + jfile = opj_data_file('input/conformance/file2.jp2') + with self.assertWarns(UserWarning): + jp2 = Jp2k(jfile) + + ids = [box.box_id for box in jp2.box] + self.assertEqual(ids, ['jP ', 'ftyp', 'jp2h', 'jp2c']) + + ids = [box.box_id for box in jp2.box[2].box] + self.assertEqual(ids, ['ihdr', 'colr', 'cdef']) + + self.verifySignatureBox(jp2.box[0]) + self.verify_filetype_box(jp2.box[1], FileTypeBox()) + + ihdr = glymur.jp2box.ImageHeaderBox(640, 480, num_components=3) + self.verifyImageHeaderBox(jp2.box[2].box[0], ihdr) + + colr = glymur.jp2box.ColourSpecificationBox(colorspace=glymur.core.YCC, + approximation=1) + self.verifyColourSpecificationBox(jp2.box[2].box[1], colr) + + # Jp2 Header + # Channel Definition + self.assertEqual(jp2.box[2].box[2].index, (0, 1, 2)) + self.assertEqual(jp2.box[2].box[2].channel_type, (0, 0, 0)) # color + self.assertEqual(jp2.box[2].box[2].association, (3, 2, 1)) # reverse + + def test_NR_file3_dump(self): + # Three 8-bit components in the sRGB-YCC colourspace, with the Cb and + # Cr components being subsampled 2x in both the horizontal and + # vertical directions. The components are stored in the standard + # order. + jfile = opj_data_file('input/conformance/file3.jp2') + with self.assertWarns(UserWarning): jp2 = Jp2k(jfile) ids = [box.box_id for box in jp2.box] @@ -5130,24 +3015,293 @@ class TestSuiteDump(unittest.TestCase): ids = [box.box_id for box in jp2.box[2].box] self.assertEqual(ids, ['ihdr', 'colr']) - # Signature box. Check for corruption. - self.assertEqual(jp2.box[0].signature, (13, 10, 135, 10)) + self.verifySignatureBox(jp2.box[0]) + self.verify_filetype_box(jp2.box[1], FileTypeBox()) + + ihdr = glymur.jp2box.ImageHeaderBox(640, 480, num_components=3) + self.verifyImageHeaderBox(jp2.box[2].box[0], ihdr) + + colr = glymur.jp2box.ColourSpecificationBox(colorspace=glymur.core.YCC, + approximation=1) + self.verifyColourSpecificationBox(jp2.box[2].box[1], colr) + + # sub-sampling + codestream = jp2.get_codestream() + self.assertEqual(codestream.segment[1].xrsiz[0], 1) + self.assertEqual(codestream.segment[1].yrsiz[0], 1) + self.assertEqual(codestream.segment[1].xrsiz[1], 2) + self.assertEqual(codestream.segment[1].yrsiz[1], 2) + self.assertEqual(codestream.segment[1].xrsiz[2], 2) + self.assertEqual(codestream.segment[1].yrsiz[2], 2) + + def test_NR_file4_dump(self): + # One 8-bit component in the grey colourspace. + jfile = opj_data_file('input/conformance/file4.jp2') + with self.assertWarns(UserWarning): + jp2 = Jp2k(jfile) + + ids = [box.box_id for box in jp2.box] + self.assertEqual(ids, ['jP ', 'ftyp', 'jp2h', 'jp2c']) + + ids = [box.box_id for box in jp2.box[2].box] + self.assertEqual(ids, ['ihdr', 'colr']) + + self.verifySignatureBox(jp2.box[0]) + self.verify_filetype_box(jp2.box[1], FileTypeBox()) + + ihdr = glymur.jp2box.ImageHeaderBox(512, 768) + self.verifyImageHeaderBox(jp2.box[2].box[0], ihdr) + + colr = glymur.jp2box.ColourSpecificationBox(colorspace=GREYSCALE, + approximation=1) + self.verifyColourSpecificationBox(jp2.box[2].box[1], colr) + + def test_NR_file5_dump(self): + # Three 8-bit components in the ROMM-RGB colourspace, encapsulated in a + # JPX file. The components have been transformed using + # the RCT. The colourspace is specified using both a Restricted ICC + # profile and using the JPX-defined enumerated code for the ROMM-RGB + # colourspace. + jfile = opj_data_file('input/conformance/file5.jp2') + with self.assertWarns(UserWarning): + # There's a warning for an unknown compatibility entry. + # Ignore it here. + jp2 = Jp2k(jfile) + + ids = [box.box_id for box in jp2.box] + self.assertEqual(ids, ['jP ', 'ftyp', 'rreq', 'jp2h', 'jp2c']) + + ids = [box.box_id for box in jp2.box[3].box] + self.assertEqual(ids, ['ihdr', 'colr', 'colr']) + + self.verifySignatureBox(jp2.box[0]) + expected = FileTypeBox(brand='jpx ', + compatibility_list=['jp2 ', 'jpx ', 'jpxb']) + self.verify_filetype_box(jp2.box[1], expected) + + ihdr = glymur.jp2box.ImageHeaderBox(512, 768, num_components=3) + self.verifyImageHeaderBox(jp2.box[3].box[0], ihdr) + + method = RESTRICTED_ICC_PROFILE + icc_profile = bytes([0] * 546) + colr = glymur.jp2box.ColourSpecificationBox(method=method, + approximation=1, + icc_profile=icc_profile) + self.verifyColourSpecificationBox(jp2.box[3].box[1], colr) + self.assertEqual(jp2.box[3].box[1].icc_profile['Size'], 546) + + def test_NR_file6_dump(self): + jfile = opj_data_file('input/conformance/file6.jp2') + with self.assertWarns(UserWarning): + jp2 = Jp2k(jfile) + + ids = [box.box_id for box in jp2.box] + self.assertEqual(ids, ['jP ', 'ftyp', 'jp2h', 'jp2c']) + + ids = [box.box_id for box in jp2.box[2].box] + self.assertEqual(ids, ['ihdr', 'colr']) + + self.verifySignatureBox(jp2.box[0]) + self.verify_filetype_box(jp2.box[1], FileTypeBox()) + + ihdr = glymur.jp2box.ImageHeaderBox(512, 768, bits_per_component=12) + self.verifyImageHeaderBox(jp2.box[2].box[0], ihdr) + + method = ENUMERATED_COLORSPACE + colr = glymur.jp2box.ColourSpecificationBox(colorspace=GREYSCALE, + method=method, + approximation=1) + self.verifyColourSpecificationBox(jp2.box[2].box[1], colr) + + def test_NR_file7_dump(self): + # Three 16-bit components in the e-sRGB colourspace, encapsulated in a + # JP2 compatible JPX file. The components have been transformed using + # the RCT. The colourspace is specified using both a Restricted ICC + # profile and using the JPX-defined enumerated code for the e-sRGB + # colourspace. + jfile = opj_data_file('input/conformance/file7.jp2') + with self.assertWarns(UserWarning): + jp2 = Jp2k(jfile) + + ids = [box.box_id for box in jp2.box] + self.assertEqual(ids, ['jP ', 'ftyp', 'rreq', 'jp2h', 'jp2c']) + + ids = [box.box_id for box in jp2.box[3].box] + self.assertEqual(ids, ['ihdr', 'colr', 'colr']) + + self.verifySignatureBox(jp2.box[0]) # File type box. - self.assertEqual(jp2.box[1].brand, 'jp2 ') - self.assertEqual(jp2.box[1].minor_version, 0) - self.assertEqual(jp2.box[1].compatibility_list[0], 'jp2 ') + self.assertEqual(jp2.box[1].brand, 'jpx ') + self.assertEqual(jp2.box[1].compatibility_list[1], 'jp2 ') - # Jp2 Header - # Image header - self.assertEqual(jp2.box[2].box[0].height, 117) - self.assertEqual(jp2.box[2].box[0].width, 117) - self.assertEqual(jp2.box[2].box[0].num_components, 4) - self.assertEqual(jp2.box[2].box[0].bits_per_component, 8) - self.assertEqual(jp2.box[2].box[0].signed, False) - self.assertEqual(jp2.box[2].box[0].compression, 7) # wavelet - self.assertEqual(jp2.box[2].box[0].colorspace_unknown, False) - self.assertEqual(jp2.box[2].box[0].ip_provided, False) + ihdr = glymur.jp2box.ImageHeaderBox(640, 480, + num_components=3, + bits_per_component=16) + self.verifyImageHeaderBox(jp2.box[3].box[0], ihdr) + + method = RESTRICTED_ICC_PROFILE + colr = glymur.jp2box.ColourSpecificationBox(method=method, + approximation=1) + self.verifyColourSpecificationBox(jp2.box[3].box[1], colr) + self.assertEqual(jp2.box[3].box[1].icc_profile['Size'], 13332) + + def test_NR_file8_dump(self): + # One 8-bit component in a gamma 1.8 space. The colourspace is + # specified using a Restricted ICC profile. + jfile = opj_data_file('input/conformance/file8.jp2') + with self.assertWarns(UserWarning): + jp2 = Jp2k(jfile) + + ids = [box.box_id for box in jp2.box] + self.assertEqual(ids, ['jP ', 'ftyp', 'jp2h', 'xml ', 'jp2c', + 'xml ']) + + ids = [box.box_id for box in jp2.box[2].box] + self.assertEqual(ids, ['ihdr', 'colr']) + + self.verifySignatureBox(jp2.box[0]) + self.verify_filetype_box(jp2.box[1], FileTypeBox()) + + ihdr = glymur.jp2box.ImageHeaderBox(400, 700) + self.verifyImageHeaderBox(jp2.box[2].box[0], ihdr) + + method = RESTRICTED_ICC_PROFILE + colr = glymur.jp2box.ColourSpecificationBox(method=method, + approximation=1) + self.verifyColourSpecificationBox(jp2.box[2].box[1], colr) + self.assertEqual(jp2.box[2].box[1].icc_profile['Size'], 414) + + # XML box + tags = [x.tag for x in jp2.box[3].xml.getroot()] + self.assertEqual(tags, + ['{http://www.jpeg.org/jpx/1.0/xml}' + + 'GENERAL_CREATION_INFO']) + + # XML box + tags = [x.tag for x in jp2.box[5].xml.getroot()] + self.assertEqual(tags, + ['{http://www.jpeg.org/jpx/1.0/xml}CAPTION', + '{http://www.jpeg.org/jpx/1.0/xml}LOCATION', + '{http://www.jpeg.org/jpx/1.0/xml}THING', + '{http://www.jpeg.org/jpx/1.0/xml}EVENT']) + + def test_NR_file9_dump(self): + # Colormap + jfile = opj_data_file('input/conformance/file9.jp2') + with self.assertWarns(UserWarning): + jp2 = Jp2k(jfile) + + ids = [box.box_id for box in jp2.box] + self.assertEqual(ids, ['jP ', 'ftyp', 'jp2h', 'jp2c']) + + ids = [box.box_id for box in jp2.box[2].box] + self.assertEqual(ids, ['ihdr', 'pclr', 'cmap', 'colr']) + + self.verifySignatureBox(jp2.box[0]) + self.verify_filetype_box(jp2.box[1], FileTypeBox()) + + ihdr = glymur.jp2box.ImageHeaderBox(512, 768) + self.verifyImageHeaderBox(jp2.box[2].box[0], ihdr) + + # Palette box. + self.assertEqual(jp2.box[2].box[1].palette.shape, (256, 3)) + np.testing.assert_array_equal(jp2.box[2].box[1].palette[0, 0], 0) + np.testing.assert_array_equal(jp2.box[2].box[1].palette[0, 1], 0) + np.testing.assert_array_equal(jp2.box[2].box[1].palette[0, 2], 0) + np.testing.assert_array_equal(jp2.box[2].box[1].palette[128, 0], 73) + np.testing.assert_array_equal(jp2.box[2].box[1].palette[128, 1], 92) + np.testing.assert_array_equal(jp2.box[2].box[1].palette[128, 2], 53) + np.testing.assert_array_equal(jp2.box[2].box[1].palette[255, 0], 245) + np.testing.assert_array_equal(jp2.box[2].box[1].palette[255, 1], 245) + np.testing.assert_array_equal(jp2.box[2].box[1].palette[255, 2], 245) + + # Component mapping box + self.assertEqual(jp2.box[2].box[2].component_index, (0, 0, 0)) + self.assertEqual(jp2.box[2].box[2].mapping_type, (1, 1, 1)) + self.assertEqual(jp2.box[2].box[2].palette_index, (0, 1, 2)) + + colr = glymur.jp2box.ColourSpecificationBox(colorspace=SRGB, + approximation=1) + self.verifyColourSpecificationBox(jp2.box[2].box[3], colr) + + def test_NR_issue188_beach_64bitsbox(self): + lst = ['input', 'nonregression', 'issue188_beach_64bitsbox.jp2'] + jfile = opj_data_file('/'.join(lst)) + with self.assertWarns(UserWarning): + # There's a warning for an unknown box. + jp2 = Jp2k(jfile) + + ids = [box.box_id for box in jp2.box] + self.assertEqual(ids, ['jP ', 'ftyp', 'jp2h', b'XML ', 'jp2c']) + + ids = [box.box_id for box in jp2.box[2].box] + self.assertEqual(ids, ['ihdr', 'colr']) + + self.verifySignatureBox(jp2.box[0]) + self.verify_filetype_box(jp2.box[1], FileTypeBox()) + + ihdr = glymur.jp2box.ImageHeaderBox(200, 200, + num_components=3, + colorspace_unknown=True) + self.verifyImageHeaderBox(jp2.box[2].box[0], ihdr) + + cspace = glymur.core.SRGB + colr = glymur.jp2box.ColourSpecificationBox(colorspace=cspace) + self.verifyColourSpecificationBox(jp2.box[2].box[1], colr) + + # Skip the 4th box, it is uknown. + + c = jp2.box[4].codestream + + ids = [x.marker_id for x in c.segment] + expected = ['SOC', 'SIZ', 'COD', 'QCD', 'CME', 'CME'] + self.assertEqual(ids, expected) + + kwargs = {'rsiz': 0, 'xysiz': (200, 200), 'xyosiz': (0, 0), + 'xytsiz': (200, 200), 'xytosiz': (0, 0), + 'bitdepth': (8, 8, 8), + 'signed': (False, False, False), + 'xyrsiz': [(1, 1, 1), (1, 1, 1)]} + self.verifySizSegment(c.segment[1], + glymur.codestream.SIZsegment(**kwargs)) + + # COD: Coding style default + self.assertFalse(c.segment[2].scod & 2) # no sop + self.assertFalse(c.segment[2].scod & 4) # no eph + self.assertEqual(c.segment[2].spcod[0], glymur.core.LRCP) + self.assertEqual(c.segment[2].layers, 1) # layers = 1 + self.assertEqual(c.segment[2].spcod[3], 1) # mct + self.assertEqual(c.segment[2].spcod[4], 5) # level + self.assertEqual(tuple(c.segment[2].code_block_size), + (64, 64)) # cblk + self.verify_codeblock_style(c.segment[2].spcod[7], + [False, False, False, False, False, False]) + self.assertEqual(c.segment[2].spcod[8], + glymur.core.WAVELET_XFORM_9X7_IRREVERSIBLE) + self.assertEqual(len(c.segment[2].spcod), 9) + + # QCD: Quantization default + self.assertEqual(c.segment[3].sqcd & 0x1f, 2) + self.assertEqual(c.segment[3].guard_bits, 1) + + def test_NR_orb_blue10_lin_jp2_dump(self): + jfile = opj_data_file('input/nonregression/orb-blue10-lin-jp2.jp2') + with self.assertWarns(UserWarning): + # This file has an invalid ICC profile + jp2 = Jp2k(jfile) + + ids = [box.box_id for box in jp2.box] + self.assertEqual(ids, ['jP ', 'ftyp', 'jp2h', 'jp2c']) + + ids = [box.box_id for box in jp2.box[2].box] + self.assertEqual(ids, ['ihdr', 'colr']) + + self.verifySignatureBox(jp2.box[0]) + self.verify_filetype_box(jp2.box[1], FileTypeBox()) + + ihdr = glymur.jp2box.ImageHeaderBox(117, 117, num_components=4) + self.verifyImageHeaderBox(jp2.box[2].box[0], ihdr) # Jp2 Header # Colour specification @@ -5158,31 +3312,19 @@ class TestSuiteDump(unittest.TestCase): self.assertIsNone(jp2.box[2].box[1].icc_profile) self.assertIsNone(jp2.box[2].box[1].colorspace) - c = jp2.box[3].main_header + c = jp2.box[3].codestream ids = [x.marker_id for x in c.segment] expected = ['SOC', 'SIZ', 'COD', 'QCD'] self.assertEqual(ids, expected) - # SIZ: Image and tile size - # Profile: - self.assertEqual(c.segment[1].rsiz, 0) - # Reference grid size - self.assertEqual(c.segment[1].xsiz, 117) - self.assertEqual(c.segment[1].ysiz, 117) - # Reference grid offset - self.assertEqual((c.segment[1].xosiz, c.segment[1].yosiz), (0, 0)) - # Tile size - self.assertEqual((c.segment[1].xtsiz, c.segment[1].ytsiz), (117, 117)) - # Tile offset - self.assertEqual((c.segment[1].xtosiz, c.segment[1].ytosiz), (0, 0)) - # bitdepth - self.assertEqual(c.segment[1].bitdepth, (8, 8, 8, 8)) - # signed - self.assertEqual(c.segment[1].signed, (False, False, False, False)) - # subsampling - self.assertEqual(list(zip(c.segment[1].xrsiz, c.segment[1].yrsiz)), - [(1, 1)] * 4) + kwargs = {'rsiz': 0, 'xysiz': (117, 117), 'xyosiz': (0, 0), + 'xytsiz': (117, 117), 'xytosiz': (0, 0), + 'bitdepth': (8, 8, 8, 8), + 'signed': (False, False, False, False), + 'xyrsiz': [(1, 1, 1, 1), (1, 1, 1, 1)]} + self.verifySizSegment(c.segment[1], + glymur.codestream.SIZsegment(**kwargs)) # COD: Coding style default self.assertFalse(c.segment[2].scod & 2) # no sop @@ -5193,18 +3335,8 @@ class TestSuiteDump(unittest.TestCase): self.assertEqual(c.segment[2].spcod[4], 5) # level self.assertEqual(tuple(c.segment[2].code_block_size), (64, 64)) # cblk - # Selective arithmetic coding bypass - self.assertFalse(c.segment[2].spcod[7] & 0x01) - # Reset context probabilities - self.assertFalse(c.segment[2].spcod[7] & 0x02) - # Termination on each coding pass - self.assertFalse(c.segment[2].spcod[7] & 0x04) - # Vertically causal context - self.assertFalse(c.segment[2].spcod[7] & 0x08) - # Predictable termination - self.assertFalse(c.segment[2].spcod[7] & 0x0010) - # Segmentation symbols - self.assertFalse(c.segment[2].spcod[7] & 0x0020) + self.verify_codeblock_style(c.segment[2].spcod[7], + [False, False, False, False, False, False]) self.assertEqual(c.segment[2].spcod[8], glymur.core.WAVELET_XFORM_5X3_REVERSIBLE) self.assertEqual(len(c.segment[2].spcod), 9) @@ -5218,9 +3350,8 @@ class TestSuiteDump(unittest.TestCase): def test_NR_orb_blue10_win_jp2_dump(self): jfile = opj_data_file('input/nonregression/orb-blue10-win-jp2.jp2') - with warnings.catch_warnings(): + with self.assertWarns(UserWarning): # This file has an invalid ICC profile - warnings.simplefilter("ignore") jp2 = Jp2k(jfile) ids = [box.box_id for box in jp2.box] @@ -5229,24 +3360,11 @@ class TestSuiteDump(unittest.TestCase): ids = [box.box_id for box in jp2.box[2].box] self.assertEqual(ids, ['ihdr', 'colr']) - # Signature box. Check for corruption. - self.assertEqual(jp2.box[0].signature, (13, 10, 135, 10)) + self.verifySignatureBox(jp2.box[0]) + self.verify_filetype_box(jp2.box[1], FileTypeBox()) - # File type box. - self.assertEqual(jp2.box[1].brand, 'jp2 ') - self.assertEqual(jp2.box[1].minor_version, 0) - self.assertEqual(jp2.box[1].compatibility_list[0], 'jp2 ') - - # Jp2 Header - # Image header - self.assertEqual(jp2.box[2].box[0].height, 117) - self.assertEqual(jp2.box[2].box[0].width, 117) - self.assertEqual(jp2.box[2].box[0].num_components, 4) - self.assertEqual(jp2.box[2].box[0].bits_per_component, 8) - self.assertEqual(jp2.box[2].box[0].signed, False) - self.assertEqual(jp2.box[2].box[0].compression, 7) # wavelet - self.assertEqual(jp2.box[2].box[0].colorspace_unknown, False) - self.assertEqual(jp2.box[2].box[0].ip_provided, False) + ihdr = glymur.jp2box.ImageHeaderBox(117, 117, num_components=4) + self.verifyImageHeaderBox(jp2.box[2].box[0], ihdr) # Jp2 Header # Colour specification @@ -5257,31 +3375,19 @@ class TestSuiteDump(unittest.TestCase): self.assertIsNone(jp2.box[2].box[1].icc_profile) self.assertIsNone(jp2.box[2].box[1].colorspace) - c = jp2.box[3].main_header + c = jp2.box[3].codestream ids = [x.marker_id for x in c.segment] expected = ['SOC', 'SIZ', 'COD', 'QCD'] self.assertEqual(ids, expected) - # SIZ: Image and tile size - # Profile: - self.assertEqual(c.segment[1].rsiz, 0) - # Reference grid size - self.assertEqual(c.segment[1].xsiz, 117) - self.assertEqual(c.segment[1].ysiz, 117) - # Reference grid offset - self.assertEqual((c.segment[1].xosiz, c.segment[1].yosiz), (0, 0)) - # Tile size - self.assertEqual((c.segment[1].xtsiz, c.segment[1].ytsiz), (117, 117)) - # Tile offset - self.assertEqual((c.segment[1].xtosiz, c.segment[1].ytosiz), (0, 0)) - # bitdepth - self.assertEqual(c.segment[1].bitdepth, (8, 8, 8, 8)) - # signed - self.assertEqual(c.segment[1].signed, (False, False, False, False)) - # subsampling - self.assertEqual(list(zip(c.segment[1].xrsiz, c.segment[1].yrsiz)), - [(1, 1)] * 4) + kwargs = {'rsiz': 0, 'xysiz': (117, 117), 'xyosiz': (0, 0), + 'xytsiz': (117, 117), 'xytosiz': (0, 0), + 'bitdepth': (8, 8, 8, 8), + 'signed': (False, False, False, False), + 'xyrsiz': [(1, 1, 1, 1), (1, 1, 1, 1)]} + self.verifySizSegment(c.segment[1], + glymur.codestream.SIZsegment(**kwargs)) # COD: Coding style default self.assertFalse(c.segment[2].scod & 2) # no sop @@ -5292,18 +3398,8 @@ class TestSuiteDump(unittest.TestCase): self.assertEqual(c.segment[2].spcod[4], 5) # level self.assertEqual(tuple(c.segment[2].code_block_size), (64, 64)) # cblk - # Selective arithmetic coding bypass - self.assertFalse(c.segment[2].spcod[7] & 0x01) - # Reset context probabilities - self.assertFalse(c.segment[2].spcod[7] & 0x02) - # Termination on each coding pass - self.assertFalse(c.segment[2].spcod[7] & 0x04) - # Vertically causal context - self.assertFalse(c.segment[2].spcod[7] & 0x08) - # Predictable termination - self.assertFalse(c.segment[2].spcod[7] & 0x0010) - # Segmentation symbols - self.assertFalse(c.segment[2].spcod[7] & 0x0020) + self.verify_codeblock_style(c.segment[2].spcod[7], + [False, False, False, False, False, False]) self.assertEqual(c.segment[2].spcod[8], glymur.core.WAVELET_XFORM_5X3_REVERSIBLE) self.assertEqual(len(c.segment[2].spcod), 9) diff --git a/glymur/test/test_opj_suite_neg.py b/glymur/test/test_opj_suite_neg.py index 5a475a2..d2351a4 100644 --- a/glymur/test/test_opj_suite_neg.py +++ b/glymur/test/test_opj_suite_neg.py @@ -2,30 +2,22 @@ The tests here do not correspond directly to the OpenJPEG test suite, but seem like logical negative tests to add. """ -# E1101: assertWarns introduced in python 3.2 -# pylint: disable=E1101 - -# R0904: Not too many methods in unittest. -# pylint: disable=R0904 - import os import re -import sys import tempfile import unittest -import warnings import numpy as np - try: import skimage.io - skimage.io.use_plugin('freeimage', 'imread') - _HAS_SKIMAGE_FREEIMAGE_SUPPORT = True -except ((ImportError, RuntimeError)): - _HAS_SKIMAGE_FREEIMAGE_SUPPORT = False +except ImportError: + pass from .fixtures import OPJ_DATA_ROOT, opj_data_file, read_image from .fixtures import NO_READ_BACKEND, NO_READ_BACKEND_MSG +from .fixtures import NO_SKIMAGE_FREEIMAGE_SUPPORT +from .fixtures import WARNING_INFRASTRUCTURE_ISSUE, WARNING_INFRASTRUCTURE_MSG +from . import fixtures from glymur import Jp2k import glymur @@ -33,7 +25,7 @@ import glymur @unittest.skipIf(OPJ_DATA_ROOT is None, "OPJ_OPJ_DATA_ROOT environment variable not set") -class TestSuiteNegative(unittest.TestCase): +class TestSuiteNegativeRead(unittest.TestCase): """Test suite for certain negative tests from openjpeg suite.""" def setUp(self): @@ -43,33 +35,6 @@ class TestSuiteNegative(unittest.TestCase): def tearDown(self): pass - - @unittest.skipIf(not _HAS_SKIMAGE_FREEIMAGE_SUPPORT, - "Cannot read input image without scikit-image/freeimage") - @unittest.skipIf(os.name == "nt", "Temporary file issue on window.") - def test_cinema2K_bad_frame_rate(self): - """Cinema2k frame rate must be either 24 or 48.""" - relfile = 'input/nonregression/X_5_2K_24_235_CBR_STEM24_000.tif' - infile = opj_data_file(relfile) - data = skimage.io.imread(infile) - with tempfile.NamedTemporaryFile(suffix='.j2k') as tfile: - j = Jp2k(tfile.name, 'wb') - with self.assertRaises(IOError): - j.write(data, cinema2k=36) - - - @unittest.skipIf(NO_READ_BACKEND, NO_READ_BACKEND_MSG) - @unittest.skipIf(os.name == "nt", "Temporary file issue on window.") - def test_psnr_with_cratios(self): - """Using psnr with cratios options is not allowed.""" - # Not an OpenJPEG test, but close. - infile = opj_data_file('input/nonregression/Bretagne1.ppm') - data = read_image(infile) - with tempfile.NamedTemporaryFile(suffix='.j2k') as tfile: - j = Jp2k(tfile.name, 'wb') - with self.assertRaises(IOError): - j.write(data, psnr=[30, 35, 40], cratios=[2, 3, 4]) - def test_nr_marker_not_compliant(self): """non-compliant marker, should still be able to read""" relpath = 'input/nonregression/MarkerIsNotCompliant.j2k' @@ -78,13 +43,13 @@ class TestSuiteNegative(unittest.TestCase): jp2k.get_codestream(header_only=False) self.assertTrue(True) + @unittest.skipIf(WARNING_INFRASTRUCTURE_ISSUE, WARNING_INFRASTRUCTURE_MSG) def test_nr_illegalclrtransform(self): """EOC marker is bad""" relpath = 'input/nonregression/illegalcolortransform.j2k' jfile = opj_data_file(relpath) jp2k = Jp2k(jfile) - with warnings.catch_warnings(record=True) as w: - warnings.simplefilter('ignore') + with self.assertWarns(UserWarning): codestream = jp2k.get_codestream(header_only=False) # Verify that the last segment returned in the codestream is SOD, @@ -100,67 +65,80 @@ class TestSuiteNegative(unittest.TestCase): jp2k.get_codestream(header_only=False) self.assertTrue(True) - @unittest.skipIf(os.name == "nt", "Temporary file issue on window.") + +@unittest.skipIf(re.match("1.5|2", glymur.version.openjpeg_version) is None, + "Must have openjpeg 1.5 or higher to run") +@unittest.skipIf(os.name == "nt", fixtures.WINDOWS_TMP_FILE_MSG) +@unittest.skipIf(OPJ_DATA_ROOT is None, + "OPJ_OPJ_DATA_ROOT environment variable not set") +class TestSuiteNegativeWrite(unittest.TestCase): + """Test suite for certain negative tests from openjpeg suite.""" + + def setUp(self): + self.jp2file = glymur.data.nemo() + self.j2kfile = glymur.data.goodstuff() + + def tearDown(self): + pass + + @unittest.skipIf(NO_SKIMAGE_FREEIMAGE_SUPPORT, + "Cannot read input image without scikit-image/freeimage") + def test_cinema2K_bad_frame_rate(self): + """Cinema2k frame rate must be either 24 or 48.""" + relfile = 'input/nonregression/X_5_2K_24_235_CBR_STEM24_000.tif' + infile = opj_data_file(relfile) + data = skimage.io.imread(infile) + with tempfile.NamedTemporaryFile(suffix='.j2k') as tfile: + with self.assertRaises(IOError): + Jp2k(tfile.name, data=data, cinema2k=36) + + @unittest.skipIf(NO_READ_BACKEND, NO_READ_BACKEND_MSG) + def test_psnr_with_cratios(self): + """Using psnr with cratios options is not allowed.""" + # Not an OpenJPEG test, but close. + infile = opj_data_file('input/nonregression/Bretagne1.ppm') + data = read_image(infile) + with tempfile.NamedTemporaryFile(suffix='.j2k') as tfile: + with self.assertRaises(IOError): + Jp2k(tfile.name, + data=data, psnr=[30, 35, 40], cratios=[2, 3, 4]) + def test_code_block_dimensions(self): """don't allow extreme codeblock sizes""" # opj_compress doesn't allow the dimensions of a codeblock # to be too small or too big, so neither will we. data = np.zeros((256, 256), dtype=np.uint8) with tempfile.NamedTemporaryFile(suffix='.j2k') as tfile: - j = Jp2k(tfile.name, 'wb') - # opj_compress doesn't allow code block area to exceed 4096. with self.assertRaises(IOError): - j.write(data, cbsize=(256, 256)) + Jp2k(tfile.name, data=data, cbsize=(256, 256)) # opj_compress doesn't allow either dimension to be less than 4. with self.assertRaises(IOError): - j.write(data, cbsize=(2048, 2)) + Jp2k(tfile.name, data=data, cbsize=(2048, 2)) with self.assertRaises(IOError): - j.write(data, cbsize=(2, 2048)) + Jp2k(tfile.name, data=data, cbsize=(2, 2048)) - def test_exceeded_box(self): - """should warn if reading past end of a box""" - # Verify that a warning is issued if we read past the end of a box - # This file has a palette (pclr) box whose length is impossibly - # short. - infile = os.path.join(OPJ_DATA_ROOT, - 'input/nonregression/mem-b2ace68c-1381.jp2') - with warnings.catch_warnings(record=True) as w: - warnings.simplefilter('ignore') - Jp2k(infile) - - @unittest.skipIf(os.name == "nt", "Temporary file issue on window.") def test_precinct_size_not_p2(self): """precinct sizes should be powers of two.""" ifile = Jp2k(self.j2kfile) - data = ifile.read(rlevel=2) + data = ifile[::4, ::4] with tempfile.NamedTemporaryFile(suffix='.jp2') as tfile: - ofile = Jp2k(tfile.name, 'wb') with self.assertRaises(IOError): - ofile.write(data, psizes=[(13, 13)]) + Jp2k(tfile.name, data=data, psizes=[(13, 13)]) - @unittest.skipIf(os.name == "nt", "Temporary file issue on window.") def test_cblk_size_not_power_of_two(self): """code block sizes should be powers of two.""" ifile = Jp2k(self.j2kfile) - data = ifile.read(rlevel=2) + data = ifile[::4, ::4] with tempfile.NamedTemporaryFile(suffix='.jp2') as tfile: - ofile = Jp2k(tfile.name, 'wb') with self.assertRaises(IOError): - ofile.write(data, cbsize=(13, 12)) + Jp2k(tfile.name, data=data, cbsize=(13, 12)) - @unittest.skipIf(os.name == "nt", "Temporary file issue on window.") def test_cblk_size_precinct_size(self): """code block sizes should never exceed half that of precinct size.""" ifile = Jp2k(self.j2kfile) - data = ifile.read(rlevel=2) + data = ifile[::4, ::4] with tempfile.NamedTemporaryFile(suffix='.jp2') as tfile: - ofile = Jp2k(tfile.name, 'wb') with self.assertRaises(IOError): - ofile.write(data, - cbsize=(64, 64), - psizes=[(64, 64)]) - -if __name__ == "__main__": - unittest.main() + Jp2k(tfile.name, data=data, cbsize=(64, 64), psizes=[(64, 64)]) diff --git a/glymur/test/test_opj_suite_warn.py b/glymur/test/test_opj_suite_warn.py deleted file mode 100644 index c39b810..0000000 --- a/glymur/test/test_opj_suite_warn.py +++ /dev/null @@ -1,376 +0,0 @@ -""" -The tests defined here roughly correspond to what is in the OpenJPEG test -suite. -""" - -# Some test names correspond with openjpeg tests. Long names are ok in this -# case. -# pylint: disable=C0103 - -# All of these tests correspond to tests in openjpeg, so no docstring is really -# needed. -# pylint: disable=C0111 - -# This module is very long, cannot be helped. -# pylint: disable=C0302 - -# unittest fools pylint with "too many public methods" -# pylint: disable=R0904 - -# Some tests use numpy test infrastructure, which means the tests never -# reference "self", so pylint claims it should be a function. No, no, no. -# pylint: disable=R0201 - -# Many tests are pretty long and that can't be helped. -# pylint: disable=R0915 - -# asserWarns introduced in python 3.2 (python2.7/pylint issue) -# pylint: disable=E1101 - -import re -import sys -import unittest - -import warnings - -import numpy as np - -from glymur import Jp2k -import glymur - -from .fixtures import OPJ_DATA_ROOT -from .fixtures import mse, peak_tolerance, read_pgx, opj_data_file - - -@unittest.skipIf(OPJ_DATA_ROOT is None, - "OPJ_DATA_ROOT environment variable not set") -class TestSuiteDumpWarnings(unittest.TestCase): - - def setUp(self): - pass - - def tearDown(self): - pass - - def test_NR_broken_jp2_dump(self): - jfile = opj_data_file('input/nonregression/broken.jp2') - with warnings.catch_warnings(record=True) as w: - warnings.simplefilter('ignore') - # colr box has bad length. - jp2 = Jp2k(jfile) - - ids = [box.box_id for box in jp2.box] - self.assertEqual(ids, ['jP ', 'ftyp', 'jp2h', 'jp2c']) - - ids = [box.box_id for box in jp2.box[2].box] - self.assertEqual(ids, ['ihdr', 'colr']) - - # Signature box. Check for corruption. - self.assertEqual(jp2.box[0].signature, (13, 10, 135, 10)) - - # File type box. - self.assertEqual(jp2.box[1].brand, 'jp2 ') - self.assertEqual(jp2.box[1].minor_version, 0) - self.assertEqual(jp2.box[1].compatibility_list[0], 'jp2 ') - - # Jp2 Header - # Image header - self.assertEqual(jp2.box[2].box[0].height, 152) - self.assertEqual(jp2.box[2].box[0].width, 203) - self.assertEqual(jp2.box[2].box[0].num_components, 3) - self.assertEqual(jp2.box[2].box[0].bits_per_component, 8) - self.assertEqual(jp2.box[2].box[0].signed, False) - self.assertEqual(jp2.box[2].box[0].compression, 7) # wavelet - self.assertEqual(jp2.box[2].box[0].colorspace_unknown, False) - self.assertEqual(jp2.box[2].box[0].ip_provided, False) - - # Jp2 Header - # Colour specification - self.assertEqual(jp2.box[2].box[1].method, - glymur.core.ENUMERATED_COLORSPACE) - self.assertEqual(jp2.box[2].box[1].precedence, 0) - self.assertEqual(jp2.box[2].box[1].approximation, 0) # not allowed? - self.assertEqual(jp2.box[2].box[1].colorspace, glymur.core.SRGB) - - c = jp2.box[3].main_header - - ids = [x.marker_id for x in c.segment] - expected = ['SOC', 'SIZ', 'CME', 'COD', 'QCD', 'QCC', 'QCC'] - self.assertEqual(ids, expected) - - # SIZ: Image and tile size - # Profile: - self.assertEqual(c.segment[1].rsiz, 0) - # Reference grid size - self.assertEqual(c.segment[1].xsiz, 203) - self.assertEqual(c.segment[1].ysiz, 152) - # Reference grid offset - self.assertEqual((c.segment[1].xosiz, c.segment[1].yosiz), (0, 0)) - # Tile size - self.assertEqual((c.segment[1].xtsiz, c.segment[1].ytsiz), (203, 152)) - # Tile offset - self.assertEqual((c.segment[1].xtosiz, c.segment[1].ytosiz), (0, 0)) - # bitdepth - self.assertEqual(c.segment[1].bitdepth, (8, 8, 8)) - # signed - self.assertEqual(c.segment[1].signed, (False, False, False)) - # subsampling - self.assertEqual(list(zip(c.segment[1].xrsiz, c.segment[1].yrsiz)), - [(1, 1)] * 3) - - # COM: comment - # Registration - self.assertEqual(c.segment[2].rcme, glymur.core.RCME_ISO_8859_1) - # Comment value - self.assertEqual(c.segment[2].ccme.decode('latin-1'), - "Creator: JasPer Version 1.701.0") - - # COD: Coding style default - self.assertFalse(c.segment[3].scod & 2) # no sop - self.assertFalse(c.segment[3].scod & 4) # no eph - self.assertEqual(c.segment[3].spcod[0], glymur.core.LRCP) - self.assertEqual(c.segment[3].layers, 1) # layers = 1 - self.assertEqual(c.segment[3].spcod[3], 1) # mct - self.assertEqual(c.segment[3].spcod[4], 5) # level - self.assertEqual(tuple(c.segment[3].code_block_size), - (64, 64)) # cblk - # Selective arithmetic coding bypass - self.assertFalse(c.segment[3].spcod[7] & 0x01) - # Reset context probabilities - self.assertFalse(c.segment[3].spcod[7] & 0x02) - # Termination on each coding pass - self.assertFalse(c.segment[3].spcod[7] & 0x04) - # Vertically causal context - self.assertFalse(c.segment[3].spcod[7] & 0x08) - # Predictable termination - self.assertFalse(c.segment[3].spcod[7] & 0x0010) - # Segmentation symbols - self.assertFalse(c.segment[3].spcod[7] & 0x0020) - self.assertEqual(c.segment[3].spcod[8], - glymur.core.WAVELET_XFORM_5X3_REVERSIBLE) - self.assertEqual(len(c.segment[3].spcod), 9) - - # QCD: Quantization default - self.assertEqual(c.segment[4].sqcd & 0x1f, 0) - self.assertEqual(c.segment[4].guard_bits, 2) - self.assertEqual(c.segment[4].mantissa, [0] * 16) - self.assertEqual(c.segment[4].exponent, - [8] + [9, 9, 10] * 5) - - # QCC: Quantization component - # associated component - self.assertEqual(c.segment[5].cqcc, 1) - self.assertEqual(c.segment[5].guard_bits, 2) - # quantization type - self.assertEqual(c.segment[5].sqcc & 0x1f, 0) # none - self.assertEqual(c.segment[5].mantissa, [0] * 16) - self.assertEqual(c.segment[5].exponent, - [8] + [9, 9, 10] * 5) - - # QCC: Quantization component - # associated component - self.assertEqual(c.segment[6].cqcc, 2) - self.assertEqual(c.segment[6].guard_bits, 2) - # quantization type - self.assertEqual(c.segment[6].sqcc & 0x1f, 0) # none - self.assertEqual(c.segment[6].mantissa, [0] * 16) - self.assertEqual(c.segment[6].exponent, - [8] + [9, 9, 10] * 5) - - def test_NR_broken2_jp2_dump(self): - # Invalid marker ID on codestream. - jfile = opj_data_file('input/nonregression/broken2.jp2') - with warnings.catch_warnings(record=True) as w: - warnings.simplefilter('ignore') - jp2 = Jp2k(jfile) - - self.assertEqual(jp2.box[-1].main_header.segment[-1].marker_id, 'QCC') - - @unittest.skipIf(sys.maxsize < 2**32, 'Do not run on 32-bit platforms') - def test_NR_broken3_jp2_dump(self): - """ - NR_broken3_jp2_dump - - The file in question here has a colr box with an erroneous box - length of over 1GB. Don't run it on 32-bit platforms. - """ - jfile = opj_data_file('input/nonregression/broken3.jp2') - with warnings.catch_warnings(record=True) as w: - warnings.simplefilter('ignore') - jp2 = Jp2k(jfile) - - ids = [box.box_id for box in jp2.box] - self.assertEqual(ids, ['jP ', 'ftyp', 'jp2h', 'jp2c']) - - ids = [box.box_id for box in jp2.box[2].box] - self.assertEqual(ids, ['ihdr', 'colr']) - - # Signature box. Check for corruption. - self.assertEqual(jp2.box[0].signature, (13, 10, 135, 10)) - - # File type box. - self.assertEqual(jp2.box[1].brand, 'jp2 ') - self.assertEqual(jp2.box[1].minor_version, 0) - self.assertEqual(jp2.box[1].compatibility_list[0], 'jp2 ') - - # Jp2 Header - # Image header - self.assertEqual(jp2.box[2].box[0].height, 152) - self.assertEqual(jp2.box[2].box[0].width, 203) - self.assertEqual(jp2.box[2].box[0].num_components, 3) - self.assertEqual(jp2.box[2].box[0].bits_per_component, 8) - self.assertEqual(jp2.box[2].box[0].signed, False) - self.assertEqual(jp2.box[2].box[0].compression, 7) # wavelet - self.assertEqual(jp2.box[2].box[0].colorspace_unknown, False) - self.assertEqual(jp2.box[2].box[0].ip_provided, False) - - # Jp2 Header - # Colour specification - self.assertEqual(jp2.box[2].box[1].method, - glymur.core.ENUMERATED_COLORSPACE) - self.assertEqual(jp2.box[2].box[1].precedence, 0) - self.assertEqual(jp2.box[2].box[1].approximation, 0) # JP2 - self.assertEqual(jp2.box[2].box[1].colorspace, glymur.core.SRGB) - - c = jp2.box[3].main_header - - ids = [x.marker_id for x in c.segment] - expected = ['SOC', 'SIZ', 'CME', 'COD', 'QCD', 'QCC', 'QCC'] - self.assertEqual(ids, expected) - - # SIZ: Image and tile size - # Profile: - self.assertEqual(c.segment[1].rsiz, 0) - # Reference grid size - self.assertEqual(c.segment[1].xsiz, 203) - self.assertEqual(c.segment[1].ysiz, 152) - # Reference grid offset - self.assertEqual((c.segment[1].xosiz, c.segment[1].yosiz), (0, 0)) - # Tile size - self.assertEqual((c.segment[1].xtsiz, c.segment[1].ytsiz), (203, 152)) - # Tile offset - self.assertEqual((c.segment[1].xtosiz, c.segment[1].ytosiz), (0, 0)) - # bitdepth - self.assertEqual(c.segment[1].bitdepth, (8, 8, 8)) - # signed - self.assertEqual(c.segment[1].signed, (False, False, False)) - # subsampling - self.assertEqual(list(zip(c.segment[1].xrsiz, c.segment[1].yrsiz)), - [(1, 1)] * 3) - - # COM: comment - # Registration - self.assertEqual(c.segment[2].rcme, glymur.core.RCME_ISO_8859_1) - # Comment value - self.assertEqual(c.segment[2].ccme.decode('latin-1'), - "Creator: JasPer Vers)on 1.701.0") - - # COD: Coding style default - self.assertFalse(c.segment[3].scod & 2) # no sop - self.assertFalse(c.segment[3].scod & 4) # no eph - self.assertEqual(c.segment[3].spcod[0], glymur.core.LRCP) - self.assertEqual(c.segment[3].layers, 1) # layers = 1 - self.assertEqual(c.segment[3].spcod[3], 1) # mct - self.assertEqual(c.segment[3].spcod[4], 5) # level - self.assertEqual(tuple(c.segment[3].code_block_size), - (64, 64)) # cblk - # Selective arithmetic coding bypass - self.assertFalse(c.segment[3].spcod[7] & 0x01) - # Reset context probabilities - self.assertFalse(c.segment[3].spcod[7] & 0x02) - # Termination on each coding pass - self.assertFalse(c.segment[3].spcod[7] & 0x04) - # Vertically causal context - self.assertFalse(c.segment[3].spcod[7] & 0x08) - # Predictable termination - self.assertFalse(c.segment[3].spcod[7] & 0x0010) - # Segmentation symbols - self.assertFalse(c.segment[3].spcod[7] & 0x0020) - self.assertEqual(c.segment[3].spcod[8], - glymur.core.WAVELET_XFORM_5X3_REVERSIBLE) - self.assertEqual(len(c.segment[3].spcod), 9) - - # QCD: Quantization default - self.assertEqual(c.segment[4].sqcd & 0x1f, 0) - self.assertEqual(c.segment[4].guard_bits, 2) - self.assertEqual(c.segment[4].mantissa, [0] * 16) - self.assertEqual(c.segment[4].exponent, - [8] + [9, 9, 10] * 5) - - # QCC: Quantization component - # associated component - self.assertEqual(c.segment[5].cqcc, 1) - self.assertEqual(c.segment[5].guard_bits, 2) - # quantization type - self.assertEqual(c.segment[5].sqcc & 0x1f, 0) # none - self.assertEqual(c.segment[5].mantissa, [0] * 16) - self.assertEqual(c.segment[5].exponent, - [8] + [9, 9, 10] * 5) - - # QCC: Quantization component - # associated component - self.assertEqual(c.segment[6].cqcc, 2) - self.assertEqual(c.segment[6].guard_bits, 2) - # quantization type - self.assertEqual(c.segment[6].sqcc & 0x1f, 0) # none - self.assertEqual(c.segment[6].mantissa, [0] * 16) - self.assertEqual(c.segment[6].exponent, - [8] + [9, 9, 10] * 5) - - def test_NR_broken4_jp2_dump(self): - # Has an invalid marker in the main header - jfile = opj_data_file('input/nonregression/broken4.jp2') - with warnings.catch_warnings(record=True) as w: - warnings.simplefilter('ignore') - jp2 = Jp2k(jfile) - - self.assertEqual(jp2.box[-1].main_header.segment[-1].marker_id, 'QCC') - - def test_NR_gdal_fuzzer_assert_in_opj_j2k_read_SQcd_SQcc_patch_jp2(self): - lst = ['input', 'nonregression', - 'gdal_fuzzer_assert_in_opj_j2k_read_SQcd_SQcc.patch.jp2'] - jfile = opj_data_file('/'.join(lst)) - with warnings.catch_warnings(record=True) as w: - warnings.simplefilter('ignore') - Jp2k(jfile) - - def test_NR_gdal_fuzzer_check_comp_dx_dy_jp2_dump(self): - lst = ['input', 'nonregression', 'gdal_fuzzer_check_comp_dx_dy.jp2'] - jfile = opj_data_file('/'.join(lst)) - with warnings.catch_warnings(record=True) as w: - warnings.simplefilter('ignore') - Jp2k(jfile) - - def test_NR_gdal_fuzzer_check_number_of_tiles(self): - # Has an impossible tiling setup. - lst = ['input', 'nonregression', - 'gdal_fuzzer_check_number_of_tiles.jp2'] - jfile = opj_data_file('/'.join(lst)) - with warnings.catch_warnings(record=True) as w: - warnings.simplefilter('ignore') - Jp2k(jfile) - - def test_NR_gdal_fuzzer_unchecked_numresolutions_dump(self): - # Has an invalid number of resolutions. - lst = ['input', 'nonregression', - 'gdal_fuzzer_unchecked_numresolutions.jp2'] - jfile = opj_data_file('/'.join(lst)) - with warnings.catch_warnings(record=True) as w: - warnings.simplefilter('ignore') - Jp2k(jfile) - - @unittest.skipIf(re.match("1.5|2.0.0", glymur.version.openjpeg_version), - "Test not passing on 1.5.x, not introduced until 2.x") - def test_NR_DEC_issue188_beach_64bitsbox_jp2_41_decode(self): - # Has an 'XML ' box instead of 'xml '. Yes that is pedantic, but it - # really does deserve a warning. - relpath = 'input/nonregression/issue188_beach_64bitsbox.jp2' - jfile = opj_data_file(relpath) - with warnings.catch_warnings(record=True) as w: - warnings.simplefilter('ignore') - j = Jp2k(jfile) - d = j.read() - - -if __name__ == "__main__": - unittest.main() diff --git a/glymur/test/test_opj_suite_write.py b/glymur/test/test_opj_suite_write.py index 5fdc0ca..f44c7b4 100644 --- a/glymur/test/test_opj_suite_write.py +++ b/glymur/test/test_opj_suite_write.py @@ -2,62 +2,91 @@ The tests defined here roughly correspond to what is in the OpenJPEG test suite. """ -# C0103: method names longer that 30 chars are ok in tests, IMHO -# R0904: Seems like pylint is fooled in this situation -# pylint: disable=R0904,C0103 - import os import re import sys import tempfile import unittest -import warnings + +if sys.hexversion <= 0x03030000: + from mock import patch +else: + from unittest.mock import patch import numpy as np - try: import skimage.io - skimage.io.use_plugin('freeimage', 'imread') - _HAS_SKIMAGE_FREEIMAGE_SUPPORT = True -except ((ImportError, RuntimeError)): - _HAS_SKIMAGE_FREEIMAGE_SUPPORT = False +except ImportError: + pass from .fixtures import read_image, NO_READ_BACKEND, NO_READ_BACKEND_MSG -from .fixtures import OPJ_DATA_ROOT, opj_data_file +from .fixtures import OPJ_DATA_ROOT, NO_SKIMAGE_FREEIMAGE_SUPPORT +from .fixtures import opj_data_file +from .fixtures import WARNING_INFRASTRUCTURE_ISSUE, WARNING_INFRASTRUCTURE_MSG from . import fixtures -from glymur import Jp2k import glymur +from glymur import Jp2k +from glymur.codestream import SIZsegment +from glymur.version import openjpeg_version -@unittest.skipIf(not _HAS_SKIMAGE_FREEIMAGE_SUPPORT, + +class CinemaBase(fixtures.MetadataBase): + + def verify_cinema_cod(self, cod_segment): + + self.assertFalse(cod_segment.scod & 2) # no sop + self.assertFalse(cod_segment.scod & 4) # no eph + self.assertEqual(cod_segment.spcod[0], glymur.core.CPRL) + self.assertEqual(cod_segment.layers, 1) + self.assertEqual(cod_segment.spcod[3], 1) # mct + self.assertEqual(cod_segment.spcod[4], 5) # levels + self.assertEqual(tuple(cod_segment.code_block_size), (32, 32)) + + def check_cinema4k_codestream(self, codestream, image_size): + + kwargs = {'rsiz': 4, 'xysiz': image_size, 'xyosiz': (0, 0), + 'xytsiz': image_size, 'xytosiz': (0, 0), + 'bitdepth': (12, 12, 12), 'signed': (False, False, False), + 'xyrsiz': [(1, 1, 1), (1, 1, 1)]} + self.verifySizSegment(codestream.segment[1], SIZsegment(**kwargs)) + + self.verify_cinema_cod(codestream.segment[2]) + + def check_cinema2k_codestream(self, codestream, image_size): + + kwargs = {'rsiz': 3, 'xysiz': image_size, 'xyosiz': (0, 0), + 'xytsiz': image_size, 'xytosiz': (0, 0), + 'bitdepth': (12, 12, 12), 'signed': (False, False, False), + 'xyrsiz': [(1, 1, 1), (1, 1, 1)]} + self.verifySizSegment(codestream.segment[1], SIZsegment(**kwargs)) + + self.verify_cinema_cod(codestream.segment[2]) + + +@unittest.skipIf(NO_SKIMAGE_FREEIMAGE_SUPPORT, "Cannot read input image without scikit-image/freeimage") -@unittest.skipIf(os.name == "nt", "no write support on windows, period") +@unittest.skipIf(os.name == "nt", fixtures.WINDOWS_TMP_FILE_MSG) @unittest.skipIf(re.match(r'''(1|2.0.0)''', glymur.version.openjpeg_version) is not None, "Uses features not supported until 2.0.1") @unittest.skipIf(OPJ_DATA_ROOT is None, "OPJ_DATA_ROOT environment variable not set") -class TestSuiteWriteCinema(unittest.TestCase): +class WriteCinema(CinemaBase): """Tests for writing with openjp2 backend. These tests either roughly correspond with those tests with similar names in the OpenJPEG test suite or are closely associated. """ - def setUp(self): - pass - - def tearDown(self): - pass - def test_cinema2K_with_others(self): """Can't specify cinema2k with any other options.""" relfile = 'input/nonregression/X_5_2K_24_235_CBR_STEM24_000.tif' infile = opj_data_file(relfile) data = skimage.io.imread(infile) with tempfile.NamedTemporaryFile(suffix='.j2k') as tfile: - j = Jp2k(tfile.name, 'wb') with self.assertRaises(IOError): - j.write(data, cinema2k=48, cratios=[200, 100, 50]) + Jp2k(tfile.name, data=data, + cinema2k=48, cratios=[200, 100, 50]) def test_cinema4K_with_others(self): """Can't specify cinema4k with any other options.""" @@ -65,180 +94,111 @@ class TestSuiteWriteCinema(unittest.TestCase): infile = opj_data_file(relfile) data = skimage.io.imread(infile) with tempfile.NamedTemporaryFile(suffix='.j2k') as tfile: - j = Jp2k(tfile.name, 'wb') with self.assertRaises(IOError): - j.write(data, cinema4k=True, cratios=[200, 100, 50]) - - def check_cinema4k_codestream(self, codestream, image_size): - """Common out for cinema2k tests.""" - # SIZ: Image and tile size - # Profile: "3" means cinema2K - self.assertEqual(codestream.segment[1].rsiz, 4) - # Reference grid size - self.assertEqual((codestream.segment[1].xsiz, - codestream.segment[1].ysiz), - image_size) - # Reference grid offset - self.assertEqual((codestream.segment[1].xosiz, - codestream.segment[1].yosiz), (0, 0)) - # Tile size - self.assertEqual((codestream.segment[1].xtsiz, - codestream.segment[1].ytsiz), - image_size) - # Tile offset - self.assertEqual((codestream.segment[1].xtosiz, - codestream.segment[1].ytosiz), - (0, 0)) - # bitdepth - self.assertEqual(codestream.segment[1].bitdepth, (12, 12, 12)) - # signed - self.assertEqual(codestream.segment[1].signed, - (False, False, False)) - # subsampling - self.assertEqual(list(zip(codestream.segment[1].xrsiz, - codestream.segment[1].yrsiz)), - [(1, 1)] * 3) - - # COD: Coding style default - self.assertFalse(codestream.segment[2].scod & 2) # no sop - self.assertFalse(codestream.segment[2].scod & 4) # no eph - self.assertEqual(codestream.segment[2].spcod[0], glymur.core.CPRL) - self.assertEqual(codestream.segment[2].layers, 1) - self.assertEqual(codestream.segment[2].spcod[3], 1) # mct - self.assertEqual(codestream.segment[2].spcod[4], 5) # levels - self.assertEqual(tuple(codestream.segment[2].code_block_size), - (32, 32)) # cblksz - - - - def check_cinema2k_codestream(self, codestream, image_size): - """Common out for cinema2k tests.""" - # SIZ: Image and tile size - # Profile: "3" means cinema2K - self.assertEqual(codestream.segment[1].rsiz, 3) - # Reference grid size - self.assertEqual((codestream.segment[1].xsiz, - codestream.segment[1].ysiz), - image_size) - # Reference grid offset - self.assertEqual((codestream.segment[1].xosiz, - codestream.segment[1].yosiz), (0, 0)) - # Tile size - self.assertEqual((codestream.segment[1].xtsiz, - codestream.segment[1].ytsiz), - image_size) - # Tile offset - self.assertEqual((codestream.segment[1].xtosiz, - codestream.segment[1].ytosiz), - (0, 0)) - # bitdepth - self.assertEqual(codestream.segment[1].bitdepth, (12, 12, 12)) - # signed - self.assertEqual(codestream.segment[1].signed, - (False, False, False)) - # subsampling - self.assertEqual(list(zip(codestream.segment[1].xrsiz, - codestream.segment[1].yrsiz)), - [(1, 1)] * 3) - - # COD: Coding style default - self.assertFalse(codestream.segment[2].scod & 2) # no sop - self.assertFalse(codestream.segment[2].scod & 4) # no eph - self.assertEqual(codestream.segment[2].spcod[0], glymur.core.CPRL) - self.assertEqual(codestream.segment[2].layers, 1) - self.assertEqual(codestream.segment[2].spcod[3], 1) # mct - self.assertEqual(codestream.segment[2].spcod[4], 5) # levels - self.assertEqual(tuple(codestream.segment[2].code_block_size), - (32, 32)) # cblksz + Jp2k(tfile.name, data=data, + cinema4k=True, cratios=[200, 100, 50]) +@unittest.skipIf(WARNING_INFRASTRUCTURE_ISSUE, WARNING_INFRASTRUCTURE_MSG) +@unittest.skipIf(NO_SKIMAGE_FREEIMAGE_SUPPORT, + "Cannot read input image without scikit-image/freeimage") +@unittest.skipIf(os.name == "nt", fixtures.WINDOWS_TMP_FILE_MSG) +@unittest.skipIf(re.match(r'''(1|2.0.0)''', + glymur.version.openjpeg_version) is not None, + "Uses features not supported until 2.0.1") +@unittest.skipIf(OPJ_DATA_ROOT is None, + "OPJ_DATA_ROOT environment variable not set") +class WriteCinemaWarns(CinemaBase): + """Tests for writing with openjp2 backend. + These tests either roughly correspond with those tests with similar names + in the OpenJPEG test suite or are closely associated. These tests issue + warnings. + """ def test_NR_ENC_ElephantDream_4K_tif_21_encode(self): relfile = 'input/nonregression/ElephantDream_4K.tif' infile = opj_data_file(relfile) data = skimage.io.imread(infile) with tempfile.NamedTemporaryFile(suffix='.j2k') as tfile: - j = Jp2k(tfile.name, 'wb') - with warnings.catch_warnings(): - # Just turn off warnings. - warnings.simplefilter("ignore") - j.write(data, cinema4k=True) + regex = 'OpenJPEG library warning:.*' + with self.assertWarnsRegex(UserWarning, re.compile(regex)): + j = Jp2k(tfile.name, data=data, cinema4k=True) codestream = j.get_codestream() self.check_cinema4k_codestream(codestream, (4096, 2160)) - def test_NR_ENC_X_5_2K_24_235_CBR_STEM24_000_tif_19_encode(self): relfile = 'input/nonregression/X_5_2K_24_235_CBR_STEM24_000.tif' infile = opj_data_file(relfile) data = skimage.io.imread(infile) with tempfile.NamedTemporaryFile(suffix='.j2k') as tfile: - j = Jp2k(tfile.name, 'wb') - j.write(data, cinema2k=48) + with self.assertWarnsRegex(UserWarning, + 'OpenJPEG library warning'): + j = Jp2k(tfile.name, data=data, cinema2k=48) codestream = j.get_codestream() self.check_cinema2k_codestream(codestream, (2048, 857)) - def test_NR_ENC_X_6_2K_24_FULL_CBR_CIRCLE_000_tif_20_encode(self): relfile = 'input/nonregression/X_6_2K_24_FULL_CBR_CIRCLE_000.tif' infile = opj_data_file(relfile) data = skimage.io.imread(infile) with tempfile.NamedTemporaryFile(suffix='.j2k') as tfile: - j = Jp2k(tfile.name, 'wb') - j.write(data, cinema2k=48) + with self.assertWarnsRegex(UserWarning, + 'OpenJPEG library warning'): + j = Jp2k(tfile.name, data=data, cinema2k=48) codestream = j.get_codestream() self.check_cinema2k_codestream(codestream, (2048, 1080)) - def test_NR_ENC_X_6_2K_24_FULL_CBR_CIRCLE_000_tif_17_encode(self): relfile = 'input/nonregression/X_6_2K_24_FULL_CBR_CIRCLE_000.tif' infile = opj_data_file(relfile) data = skimage.io.imread(infile) with tempfile.NamedTemporaryFile(suffix='.j2k') as tfile: - j = Jp2k(tfile.name, 'wb') - j.write(data, cinema2k=24) + with self.assertWarnsRegex(UserWarning, + 'OpenJPEG library warning'): + j = Jp2k(tfile.name, data=data, cinema2k=24) codestream = j.get_codestream() self.check_cinema2k_codestream(codestream, (2048, 1080)) - def test_NR_ENC_X_5_2K_24_235_CBR_STEM24_000_tif_16_encode(self): relfile = 'input/nonregression/X_5_2K_24_235_CBR_STEM24_000.tif' infile = opj_data_file(relfile) data = skimage.io.imread(infile) with tempfile.NamedTemporaryFile(suffix='.j2k') as tfile: - j = Jp2k(tfile.name, 'wb') - j.write(data, cinema2k=24) + with self.assertWarnsRegex(UserWarning, + 'OpenJPEG library warning'): + # OpenJPEG library warning: The desired maximum codestream + # size has limited at least one of the desired quality layers + j = Jp2k(tfile.name, data=data, cinema2k=24) codestream = j.get_codestream() self.check_cinema2k_codestream(codestream, (2048, 857)) - def test_NR_ENC_X_4_2K_24_185_CBR_WB_000_tif_18_encode(self): relfile = 'input/nonregression/X_4_2K_24_185_CBR_WB_000.tif' infile = opj_data_file(relfile) data = skimage.io.imread(infile) with tempfile.NamedTemporaryFile(suffix='.j2k') as tfile: - j = Jp2k(tfile.name, 'wb') - with warnings.catch_warnings(): - # Just turn off warnings. - warnings.simplefilter("ignore") - j.write(data, cinema2k=48) + regex = 'OpenJPEG library warning' + with self.assertWarnsRegex(UserWarning, regex): + # OpenJPEG library warning: The desired maximum codestream + # size has limited at least one of the desired quality layers + j = Jp2k(tfile.name, data=data, cinema2k=48) codestream = j.get_codestream() self.check_cinema2k_codestream(codestream, (1998, 1080)) -@unittest.skipIf(not _HAS_SKIMAGE_FREEIMAGE_SUPPORT, + +@unittest.skipIf(NO_SKIMAGE_FREEIMAGE_SUPPORT, "Cannot read input image without scikit-image/freeimage") -@unittest.skipIf(os.name == "nt", "Temporary file issue on window.") -@unittest.skipIf(not re.match("(1.5|2.0.0)", glymur.version.openjpeg_version), - "Functionality implemented for 2.0.1") +@unittest.skipIf(os.name == "nt", fixtures.WINDOWS_TMP_FILE_MSG) @unittest.skipIf(OPJ_DATA_ROOT is None, "OPJ_OPJ_DATA_ROOT environment variable not set") -class TestSuiteNegative2pointzero(unittest.TestCase): - """Feature set not supported for versions less than 2.0""" +class TestNegative2pointzero(unittest.TestCase): + """Feature set not supported for versions less than 2.0.1""" def setUp(self): self.jp2file = glymur.data.nemo() @@ -248,20 +208,25 @@ class TestSuiteNegative2pointzero(unittest.TestCase): pass def test_cinema_mode(self): + """Cinema mode not allowed for anything less than 2.0.1""" relfile = 'input/nonregression/X_4_2K_24_185_CBR_WB_000.tif' infile = opj_data_file(relfile) data = skimage.io.imread(infile) - with tempfile.NamedTemporaryFile(suffix='.j2k') as tfile: - j = Jp2k(tfile.name, 'wb') - with self.assertRaises(IOError): - j.write(data, cinema2k=48) + versions = ["1.5.0", "2.0.0"] + for version in versions: + with patch('glymur.version.openjpeg_version', new=version): + with tempfile.NamedTemporaryFile(suffix='.j2k') as tfile: + with self.assertRaises(IOError): + Jp2k(tfile.name, data=data, cinema2k=48) -@unittest.skipIf(os.name == "nt", "no write support on windows, period") +@unittest.skipIf(re.match(r'''1.[0-4]''', openjpeg_version) is not None, + "Writing not supported until OpenJPEG 1.5") +@unittest.skipIf(os.name == "nt", fixtures.WINDOWS_TMP_FILE_MSG) @unittest.skipIf(NO_READ_BACKEND, NO_READ_BACKEND_MSG) @unittest.skipIf(OPJ_DATA_ROOT is None, "OPJ_DATA_ROOT environment variable not set") -class TestSuiteWrite(unittest.TestCase): +class TestSuiteWrite(fixtures.MetadataBase): """Tests for writing with openjp2 backend. These tests either roughly correspond with those tests with similar names @@ -278,117 +243,60 @@ class TestSuiteWrite(unittest.TestCase): expdata = np.fromfile(filename, dtype=np.uint16) expdata.resize((2816, 2048)) with tempfile.NamedTemporaryFile(suffix='.j2k') as tfile: - j = Jp2k(tfile.name, 'wb') - j.write(expdata, irreversible=True) + j = Jp2k(tfile.name, data=expdata, irreversible=True) codestream = j.get_codestream() self.assertEqual(codestream.segment[2].spcod[8], glymur.core.WAVELET_XFORM_9X7_IRREVERSIBLE) - def test_NR_ENC_Bretagne1_ppm_1_encode(self): """NR-ENC-Bretagne1.ppm-1-encode""" infile = opj_data_file('input/nonregression/Bretagne1.ppm') data = read_image(infile) with tempfile.NamedTemporaryFile(suffix='.j2k') as tfile: - j = Jp2k(tfile.name, 'wb') - j.write(data, cratios=[200, 100, 50]) + j = Jp2k(tfile.name, data=data, cratios=[200, 100, 50]) # Should be three layers. - codestream = j.get_codestream() + c = j.get_codestream() - # SIZ: Image and tile size - # Profile: "0" means profile 2 - self.assertEqual(codestream.segment[1].rsiz, 0) - # Reference grid size - self.assertEqual((codestream.segment[1].xsiz, - codestream.segment[1].ysiz), - (640, 480)) - # Reference grid offset - self.assertEqual((codestream.segment[1].xosiz, - codestream.segment[1].yosiz), (0, 0)) - # Tile size - self.assertEqual((codestream.segment[1].xtsiz, - codestream.segment[1].ytsiz), - (640, 480)) - # Tile offset - self.assertEqual((codestream.segment[1].xtosiz, - codestream.segment[1].ytosiz), - (0, 0)) - # bitdepth - self.assertEqual(codestream.segment[1].bitdepth, (8, 8, 8)) - # signed - self.assertEqual(codestream.segment[1].signed, - (False, False, False)) - # subsampling - self.assertEqual(list(zip(codestream.segment[1].xrsiz, - codestream.segment[1].yrsiz)), - [(1, 1)] * 3) + kwargs = {'rsiz': 0, 'xysiz': (640, 480), 'xyosiz': (0, 0), + 'xytsiz': (640, 480), 'xytosiz': (0, 0), + 'bitdepth': (8, 8, 8), 'signed': (False, False, False), + 'xyrsiz': [(1, 1, 1), (1, 1, 1)]} + self.verifySizSegment(c.segment[1], + glymur.codestream.SIZsegment(**kwargs)) - # COD: Coding style default - self.assertFalse(codestream.segment[2].scod & 2) # no sop - self.assertFalse(codestream.segment[2].scod & 4) # no eph - self.assertEqual(codestream.segment[2].spcod[0], glymur.core.LRCP) - self.assertEqual(codestream.segment[2].layers, 3) # layers = 3 - self.assertEqual(codestream.segment[2].spcod[3], 1) # mct - self.assertEqual(codestream.segment[2].spcod[4], 5) # levels - self.assertEqual(tuple(codestream.segment[2].code_block_size), - (64, 64)) # cblksz - # Selective arithmetic coding bypass - self.assertFalse(codestream.segment[2].spcod[7] & 0x01) - # Reset context probabilities - self.assertFalse(codestream.segment[2].spcod[7] & 0x02) - # Termination on each coding pass - self.assertFalse(codestream.segment[2].spcod[7] & 0x04) - # Vertically causal context - self.assertFalse(codestream.segment[2].spcod[7] & 0x08) - # Predictable termination - self.assertFalse(codestream.segment[2].spcod[7] & 0x0010) - # Segmentation symbols - self.assertFalse(codestream.segment[2].spcod[7] & 0x0020) - self.assertEqual(codestream.segment[2].spcod[8], - glymur.core.WAVELET_XFORM_5X3_REVERSIBLE) - self.assertEqual(len(codestream.segment[2].spcod), 9) + # COD: Coding style default + self.assertFalse(c.segment[2].scod & 2) # no sop + self.assertFalse(c.segment[2].scod & 4) # no eph + self.assertEqual(c.segment[2].spcod[0], glymur.core.LRCP) + self.assertEqual(c.segment[2].layers, 3) # layers = 3 + self.assertEqual(c.segment[2].spcod[3], 1) # mct + self.assertEqual(c.segment[2].spcod[4], 5) # levels + self.assertEqual(tuple(c.segment[2].code_block_size), + (64, 64)) # cblksz + self.verify_codeblock_style(c.segment[2].spcod[7], + [False, False, False, False, False, False]) + self.assertEqual(c.segment[2].spcod[8], + glymur.core.WAVELET_XFORM_5X3_REVERSIBLE) + self.assertEqual(len(c.segment[2].spcod), 9) def test_NR_ENC_Bretagne1_ppm_2_encode(self): """NR-ENC-Bretagne1.ppm-2-encode""" infile = opj_data_file('input/nonregression/Bretagne1.ppm') data = read_image(infile) with tempfile.NamedTemporaryFile(suffix='.j2k') as tfile: - j = Jp2k(tfile.name, 'wb') - j.write(data, psnr=[30, 35, 40], numres=2) + j = Jp2k(tfile.name, data=data, psnr=[30, 35, 40], numres=2) # Should be three layers. codestream = j.get_codestream() - # SIZ: Image and tile size - # Profile: "0" means profile 2 - self.assertEqual(codestream.segment[1].rsiz, 0) - # Reference grid size - self.assertEqual((codestream.segment[1].xsiz, - codestream.segment[1].ysiz), - (640, 480)) - # Reference grid offset - self.assertEqual((codestream.segment[1].xosiz, - codestream.segment[1].yosiz), (0, 0)) - # Tile size - self.assertEqual((codestream.segment[1].xtsiz, - codestream.segment[1].ytsiz), - (640, 480)) - # Tile offset - self.assertEqual((codestream.segment[1].xtosiz, - codestream.segment[1].ytosiz), - (0, 0)) - # bitdepth - self.assertEqual(codestream.segment[1].bitdepth, - (8, 8, 8)) - # signed - self.assertEqual(codestream.segment[1].signed, - (False, False, False)) - # subsampling - self.assertEqual(list(zip(codestream.segment[1].xrsiz, - codestream.segment[1].yrsiz)), - [(1, 1)] * 3) + kwargs = {'rsiz': 0, 'xysiz': (640, 480), 'xyosiz': (0, 0), + 'xytsiz': (640, 480), 'xytosiz': (0, 0), + 'bitdepth': (8, 8, 8), 'signed': (False, False, False), + 'xyrsiz': [(1, 1, 1), (1, 1, 1)]} + self.verifySizSegment(codestream.segment[1], + glymur.codestream.SIZsegment(**kwargs)) # COD: Coding style default self.assertFalse(codestream.segment[2].scod & 2) # no sop @@ -399,18 +307,9 @@ class TestSuiteWrite(unittest.TestCase): self.assertEqual(codestream.segment[2].spcod[4], 1) # levels self.assertEqual(tuple(codestream.segment[2].code_block_size), (64, 64)) # cblksz - # Selective arithmetic coding bypass - self.assertFalse(codestream.segment[2].spcod[7] & 0x01) - # Reset context probabilities - self.assertFalse(codestream.segment[2].spcod[7] & 0x02) - # Termination on each coding pass - self.assertFalse(codestream.segment[2].spcod[7] & 0x04) - # Vertically causal context - self.assertFalse(codestream.segment[2].spcod[7] & 0x08) - # Predictable termination - self.assertFalse(codestream.segment[2].spcod[7] & 0x0010) - # Segmentation symbols - self.assertFalse(codestream.segment[2].spcod[7] & 0x0020) + self.verify_codeblock_style(codestream.segment[2].spcod[7], + [False, False, + False, False, False, False]) self.assertEqual(codestream.segment[2].spcod[8], glymur.core.WAVELET_XFORM_5X3_REVERSIBLE) self.assertEqual(len(codestream.segment[2].spcod), 9) @@ -420,40 +319,19 @@ class TestSuiteWrite(unittest.TestCase): infile = opj_data_file('input/nonregression/Bretagne1.ppm') data = read_image(infile) with tempfile.NamedTemporaryFile(suffix='.j2k') as tfile: - j = Jp2k(tfile.name, 'wb') - j.write(data, psnr=[30, 35, 40], cbsize=(16, 16), - psizes=[(64, 64)]) + j = Jp2k(tfile.name, + data=data, + psnr=[30, 35, 40], cbsize=(16, 16), psizes=[(64, 64)]) # Should be three layers. codestream = j.get_codestream() - # SIZ: Image and tile size - # Profile: "0" means profile 2 - self.assertEqual(codestream.segment[1].rsiz, 0) - # Reference grid size - self.assertEqual((codestream.segment[1].xsiz, - codestream.segment[1].ysiz), - (640, 480)) - # Reference grid offset - self.assertEqual((codestream.segment[1].xosiz, - codestream.segment[1].yosiz), (0, 0)) - # Tile size - self.assertEqual((codestream.segment[1].xtsiz, - codestream.segment[1].ytsiz), - (640, 480)) - # Tile offset - self.assertEqual((codestream.segment[1].xtosiz, - codestream.segment[1].ytosiz), - (0, 0)) - # bitdepth - self.assertEqual(codestream.segment[1].bitdepth, (8, 8, 8)) - # signed - self.assertEqual(codestream.segment[1].signed, - (False, False, False)) - # subsampling - self.assertEqual(list(zip(codestream.segment[1].xrsiz, - codestream.segment[1].yrsiz)), - [(1, 1)] * 3) + kwargs = {'rsiz': 0, 'xysiz': (640, 480), 'xyosiz': (0, 0), + 'xytsiz': (640, 480), 'xytosiz': (0, 0), + 'bitdepth': (8, 8, 8), 'signed': (False, False, False), + 'xyrsiz': [(1, 1, 1), (1, 1, 1)]} + self.verifySizSegment(codestream.segment[1], + glymur.codestream.SIZsegment(**kwargs)) # COD: Coding style default self.assertFalse(codestream.segment[2].scod & 2) # no sop @@ -464,18 +342,9 @@ class TestSuiteWrite(unittest.TestCase): self.assertEqual(codestream.segment[2].spcod[4], 5) # levels self.assertEqual(tuple(codestream.segment[2].code_block_size), (16, 16)) # cblksz - # Selective arithmetic coding bypass - self.assertFalse(codestream.segment[2].spcod[7] & 0x01) - # Reset context probabilities - self.assertFalse(codestream.segment[2].spcod[7] & 0x02) - # Termination on each coding pass - self.assertFalse(codestream.segment[2].spcod[7] & 0x04) - # Vertically causal context - self.assertFalse(codestream.segment[2].spcod[7] & 0x08) - # Predictable termination - self.assertFalse(codestream.segment[2].spcod[7] & 0x0010) - # Segmentation symbols - self.assertFalse(codestream.segment[2].spcod[7] & 0x0020) + self.verify_codeblock_style(codestream.segment[2].spcod[7], + [False, False, + False, False, False, False]) self.assertEqual(codestream.segment[2].spcod[8], glymur.core.WAVELET_XFORM_5X3_REVERSIBLE) self.assertEqual(codestream.segment[2].precinct_size, @@ -487,43 +356,22 @@ class TestSuiteWrite(unittest.TestCase): infile = opj_data_file('input/nonregression/Bretagne2.ppm') data = read_image(infile) with tempfile.NamedTemporaryFile(suffix='.j2k') as tfile: - j = Jp2k(tfile.name, 'wb') - j.write(data, - psizes=[(128, 128)] * 3, - cratios=[100, 20, 2], - tilesize=(480, 640), - cbsize=(32, 32)) + j = Jp2k(tfile.name, + data=data, + psizes=[(128, 128)] * 3, + cratios=[100, 20, 2], + tilesize=(480, 640), + cbsize=(32, 32)) # Should be three layers. codestream = j.get_codestream() - # SIZ: Image and tile size - # Profile: "0" means profile 2 - self.assertEqual(codestream.segment[1].rsiz, 0) - # Reference grid size - self.assertEqual((codestream.segment[1].xsiz, - codestream.segment[1].ysiz), - (data.shape[1], data.shape[0])) - # Reference grid offset - self.assertEqual((codestream.segment[1].xosiz, - codestream.segment[1].yosiz), (0, 0)) - # Tile size. Reported as XY, not RC. - self.assertEqual((codestream.segment[1].xtsiz, - codestream.segment[1].ytsiz), - (640, 480)) - # Tile offset - self.assertEqual((codestream.segment[1].xtosiz, - codestream.segment[1].ytosiz), - (0, 0)) - # bitdepth - self.assertEqual(codestream.segment[1].bitdepth, (8, 8, 8)) - # signed - self.assertEqual(codestream.segment[1].signed, - (False, False, False)) - # subsampling - self.assertEqual(list(zip(codestream.segment[1].xrsiz, - codestream.segment[1].yrsiz)), - [(1, 1)] * 3) + kwargs = {'rsiz': 0, 'xysiz': (2592, 1944), 'xyosiz': (0, 0), + 'xytsiz': (640, 480), 'xytosiz': (0, 0), + 'bitdepth': (8, 8, 8), 'signed': (False, False, False), + 'xyrsiz': [(1, 1, 1), (1, 1, 1)]} + self.verifySizSegment(codestream.segment[1], + glymur.codestream.SIZsegment(**kwargs)) # COD: Coding style default self.assertFalse(codestream.segment[2].scod & 2) # no sop @@ -534,18 +382,9 @@ class TestSuiteWrite(unittest.TestCase): self.assertEqual(codestream.segment[2].spcod[4], 5) # levels self.assertEqual(tuple(codestream.segment[2].code_block_size), (32, 32)) # cblksz - # Selective arithmetic coding bypass - self.assertFalse(codestream.segment[2].spcod[7] & 0x01) - # Reset context probabilities - self.assertFalse(codestream.segment[2].spcod[7] & 0x02) - # Termination on each coding pass - self.assertFalse(codestream.segment[2].spcod[7] & 0x04) - # Vertically causal context - self.assertFalse(codestream.segment[2].spcod[7] & 0x08) - # Predictable termination - self.assertFalse(codestream.segment[2].spcod[7] & 0x0010) - # Segmentation symbols - self.assertFalse(codestream.segment[2].spcod[7] & 0x0020) + self.verify_codeblock_style(codestream.segment[2].spcod[7], + [False, False, + False, False, False, False]) self.assertEqual(codestream.segment[2].spcod[8], glymur.core.WAVELET_XFORM_5X3_REVERSIBLE) self.assertEqual(codestream.segment[2].precinct_size, @@ -556,38 +395,16 @@ class TestSuiteWrite(unittest.TestCase): infile = opj_data_file('input/nonregression/Bretagne2.ppm') data = read_image(infile) with tempfile.NamedTemporaryFile(suffix='.j2k') as tfile: - j = Jp2k(tfile.name, 'wb') - j.write(data, tilesize=(127, 127), prog="PCRL") + j = Jp2k(tfile.name, data=data, tilesize=(127, 127), prog="PCRL") codestream = j.get_codestream() - # SIZ: Image and tile size - # Profile: "0" means profile 2 - self.assertEqual(codestream.segment[1].rsiz, 0) - # Reference grid size - self.assertEqual((codestream.segment[1].xsiz, - codestream.segment[1].ysiz), - (data.shape[1], data.shape[0])) - # Reference grid offset - self.assertEqual((codestream.segment[1].xosiz, - codestream.segment[1].yosiz), (0, 0)) - # Tile size - self.assertEqual((codestream.segment[1].xtsiz, - codestream.segment[1].ytsiz), - (127, 127)) - # Tile offset - self.assertEqual((codestream.segment[1].xtosiz, - codestream.segment[1].ytosiz), - (0, 0)) - # bitdepth - self.assertEqual(codestream.segment[1].bitdepth, (8, 8, 8)) - # signed - self.assertEqual(codestream.segment[1].signed, - (False, False, False)) - # subsampling - self.assertEqual(list(zip(codestream.segment[1].xrsiz, - codestream.segment[1].yrsiz)), - [(1, 1)] * 3) + kwargs = {'rsiz': 0, 'xysiz': (2592, 1944), 'xyosiz': (0, 0), + 'xytsiz': (127, 127), 'xytosiz': (0, 0), + 'bitdepth': (8, 8, 8), 'signed': (False, False, False), + 'xyrsiz': [(1, 1, 1), (1, 1, 1)]} + self.verifySizSegment(codestream.segment[1], + glymur.codestream.SIZsegment(**kwargs)) # COD: Coding style default self.assertFalse(codestream.segment[2].scod & 2) # no sop @@ -598,18 +415,9 @@ class TestSuiteWrite(unittest.TestCase): self.assertEqual(codestream.segment[2].spcod[4], 5) # levels self.assertEqual(tuple(codestream.segment[2].code_block_size), (64, 64)) # cblksz - # Selective arithmetic coding bypass - self.assertFalse(codestream.segment[2].spcod[7] & 0x01) - # Reset context probabilities - self.assertFalse(codestream.segment[2].spcod[7] & 0x02) - # Termination on each coding pass - self.assertFalse(codestream.segment[2].spcod[7] & 0x04) - # Vertically causal context - self.assertFalse(codestream.segment[2].spcod[7] & 0x08) - # Predictable termination - self.assertFalse(codestream.segment[2].spcod[7] & 0x0010) - # Segmentation symbols - self.assertFalse(codestream.segment[2].spcod[7] & 0x0020) + self.verify_codeblock_style(codestream.segment[2].spcod[7], + [False, False, + False, False, False, False]) self.assertEqual(codestream.segment[2].spcod[8], glymur.core.WAVELET_XFORM_5X3_REVERSIBLE) self.assertEqual(len(codestream.segment[2].spcod), 9) @@ -619,38 +427,16 @@ class TestSuiteWrite(unittest.TestCase): infile = opj_data_file('input/nonregression/Bretagne2.ppm') data = read_image(infile) with tempfile.NamedTemporaryFile(suffix='.j2k') as tfile: - j = Jp2k(tfile.name, 'wb') - j.write(data, subsam=(2, 2), sop=True) + j = Jp2k(tfile.name, data=data, subsam=(2, 2), sop=True) codestream = j.get_codestream(header_only=False) - # SIZ: Image and tile size - # Profile: "0" means profile 2 - self.assertEqual(codestream.segment[1].rsiz, 0) - # Reference grid size - self.assertEqual((codestream.segment[1].xsiz, - codestream.segment[1].ysiz), - (5183, 3887)) - # Reference grid offset - self.assertEqual((codestream.segment[1].xosiz, - codestream.segment[1].yosiz), (0, 0)) - # Tile size - self.assertEqual((codestream.segment[1].xtsiz, - codestream.segment[1].ytsiz), - (5183, 3887)) - # Tile offset - self.assertEqual((codestream.segment[1].xtosiz, - codestream.segment[1].ytosiz), - (0, 0)) - # bitdepth - self.assertEqual(codestream.segment[1].bitdepth, (8, 8, 8)) - # signed - self.assertEqual(codestream.segment[1].signed, - (False, False, False)) - # subsampling - self.assertEqual(list(zip(codestream.segment[1].xrsiz, - codestream.segment[1].yrsiz)), - [(2, 2)] * 3) + kwargs = {'rsiz': 0, 'xysiz': (5183, 3887), 'xyosiz': (0, 0), + 'xytsiz': (5183, 3887), 'xytosiz': (0, 0), + 'bitdepth': (8, 8, 8), 'signed': (False, False, False), + 'xyrsiz': [(2, 2, 2), (2, 2, 2)]} + self.verifySizSegment(codestream.segment[1], + glymur.codestream.SIZsegment(**kwargs)) # COD: Coding style default self.assertTrue(codestream.segment[2].scod & 2) # sop @@ -661,18 +447,9 @@ class TestSuiteWrite(unittest.TestCase): self.assertEqual(codestream.segment[2].spcod[4], 5) # levels self.assertEqual(tuple(codestream.segment[2].code_block_size), (64, 64)) # cblksz - # Selective arithmetic coding bypass - self.assertFalse(codestream.segment[2].spcod[7] & 0x01) - # Reset context probabilities - self.assertFalse(codestream.segment[2].spcod[7] & 0x02) - # Termination on each coding pass - self.assertFalse(codestream.segment[2].spcod[7] & 0x04) - # Vertically causal context - self.assertFalse(codestream.segment[2].spcod[7] & 0x08) - # Predictable termination - self.assertFalse(codestream.segment[2].spcod[7] & 0x0010) - # Segmentation symbols - self.assertFalse(codestream.segment[2].spcod[7] & 0x0020) + self.verify_codeblock_style(codestream.segment[2].spcod[7], + [False, False, False, + False, False, False]) self.assertEqual(codestream.segment[2].spcod[8], glymur.core.WAVELET_XFORM_5X3_REVERSIBLE) self.assertEqual(len(codestream.segment[2].spcod), 9) @@ -687,38 +464,16 @@ class TestSuiteWrite(unittest.TestCase): infile = opj_data_file('input/nonregression/Bretagne2.ppm') data = read_image(infile) with tempfile.NamedTemporaryFile(suffix='.j2k') as tfile: - j = Jp2k(tfile.name, 'wb') - j.write(data, modesw=38, eph=True) + j = Jp2k(tfile.name, data=data, modesw=38, eph=True) codestream = j.get_codestream(header_only=False) - # SIZ: Image and tile size - # Profile: "0" means profile 2 - self.assertEqual(codestream.segment[1].rsiz, 0) - # Reference grid size - self.assertEqual((codestream.segment[1].xsiz, - codestream.segment[1].ysiz), - (2592, 1944)) - # Reference grid offset - self.assertEqual((codestream.segment[1].xosiz, - codestream.segment[1].yosiz), (0, 0)) - # Tile size - self.assertEqual((codestream.segment[1].xtsiz, - codestream.segment[1].ytsiz), - (2592, 1944)) - # Tile offset - self.assertEqual((codestream.segment[1].xtosiz, - codestream.segment[1].ytosiz), - (0, 0)) - # bitdepth - self.assertEqual(codestream.segment[1].bitdepth, (8, 8, 8)) - # signed - self.assertEqual(codestream.segment[1].signed, - (False, False, False)) - # subsampling - self.assertEqual(list(zip(codestream.segment[1].xrsiz, - codestream.segment[1].yrsiz)), - [(1, 1)] * 3) + kwargs = {'rsiz': 0, 'xysiz': (2592, 1944), 'xyosiz': (0, 0), + 'xytsiz': (2592, 1944), 'xytosiz': (0, 0), + 'bitdepth': (8, 8, 8), 'signed': (False, False, False), + 'xyrsiz': [(1, 1, 1), (1, 1, 1)]} + self.verifySizSegment(codestream.segment[1], + glymur.codestream.SIZsegment(**kwargs)) # COD: Coding style default self.assertFalse(codestream.segment[2].scod & 2) # no sop @@ -728,19 +483,10 @@ class TestSuiteWrite(unittest.TestCase): self.assertEqual(codestream.segment[2].spcod[3], 1) # mct self.assertEqual(codestream.segment[2].spcod[4], 5) # levels self.assertEqual(tuple(codestream.segment[2].code_block_size), - (64, 64)) # cblksz - # Selective arithmetic coding BYPASS - self.assertFalse(codestream.segment[2].spcod[7] & 0x01) - # RESET context probabilities (RESET) - self.assertTrue(codestream.segment[2].spcod[7] & 0x02) - # Termination on each coding pass, RESTART(TERMALL) - self.assertTrue(codestream.segment[2].spcod[7] & 0x04) - # Vertically causal context (VSC) - self.assertFalse(codestream.segment[2].spcod[7] & 0x08) - # Predictable termination, ERTERM(SEGTERM) - self.assertFalse(codestream.segment[2].spcod[7] & 0x0010) - # Segmentation symbols, SEGMARK(SEGSYSM) - self.assertTrue(codestream.segment[2].spcod[7] & 0x0020) + (64, 64)) # cblksz + self.verify_codeblock_style(codestream.segment[2].spcod[7], + [False, True, True, + False, False, True]) self.assertEqual(codestream.segment[2].spcod[8], glymur.core.WAVELET_XFORM_5X3_REVERSIBLE) self.assertEqual(len(codestream.segment[2].spcod), 9) @@ -754,39 +500,17 @@ class TestSuiteWrite(unittest.TestCase): infile = opj_data_file('input/nonregression/Bretagne2.ppm') data = read_image(infile) with tempfile.NamedTemporaryFile(suffix='.j2k') as tfile: - j = Jp2k(tfile.name, 'wb') - j.write(data, grid_offset=[300, 150], cratios=[800]) + j = Jp2k(tfile.name, + data=data, grid_offset=[300, 150], cratios=[800]) codestream = j.get_codestream(header_only=False) - # SIZ: Image and tile size - # Profile: "0" means profile 2 - self.assertEqual(codestream.segment[1].rsiz, 0) - # Reference grid size - self.assertEqual((codestream.segment[1].xsiz, - codestream.segment[1].ysiz), - (2742, 2244)) - # Reference grid offset - self.assertEqual((codestream.segment[1].xosiz, - codestream.segment[1].yosiz), - (150, 300)) - # Tile size - self.assertEqual((codestream.segment[1].xtsiz, - codestream.segment[1].ytsiz), - (2742, 2244)) - # Tile offset - self.assertEqual((codestream.segment[1].xtosiz, - codestream.segment[1].ytosiz), - (0, 0)) - # bitdepth - self.assertEqual(codestream.segment[1].bitdepth, (8, 8, 8)) - # signed - self.assertEqual(codestream.segment[1].signed, - (False, False, False)) - # subsampling - self.assertEqual(list(zip(codestream.segment[1].xrsiz, - codestream.segment[1].yrsiz)), - [(1, 1)] * 3) + kwargs = {'rsiz': 0, 'xysiz': (2742, 2244), 'xyosiz': (150, 300), + 'xytsiz': (2742, 2244), 'xytosiz': (0, 0), + 'bitdepth': (8, 8, 8), 'signed': (False, False, False), + 'xyrsiz': [(1, 1, 1), (1, 1, 1)]} + self.verifySizSegment(codestream.segment[1], + glymur.codestream.SIZsegment(**kwargs)) # COD: Coding style default self.assertFalse(codestream.segment[2].scod & 2) # no sop @@ -797,18 +521,9 @@ class TestSuiteWrite(unittest.TestCase): self.assertEqual(codestream.segment[2].spcod[4], 5) # levels self.assertEqual(tuple(codestream.segment[2].code_block_size), (64, 64)) # cblksz - # Selective arithmetic coding BYPASS - self.assertFalse(codestream.segment[2].spcod[7] & 0x01) - # RESET context probabilities (RESET) - self.assertFalse(codestream.segment[2].spcod[7] & 0x02) - # Termination on each coding pass, RESTART(TERMALL) - self.assertFalse(codestream.segment[2].spcod[7] & 0x04) - # Vertically causal context (VSC) - self.assertFalse(codestream.segment[2].spcod[7] & 0x08) - # Predictable termination, ERTERM(SEGTERM) - self.assertFalse(codestream.segment[2].spcod[7] & 0x0010) - # Segmentation symbols, SEGMARK(SEGSYSM) - self.assertFalse(codestream.segment[2].spcod[7] & 0x0020) + self.verify_codeblock_style(codestream.segment[2].spcod[7], + [False, False, False, + False, False, False]) self.assertEqual(codestream.segment[2].spcod[8], glymur.core.WAVELET_XFORM_5X3_REVERSIBLE) self.assertEqual(len(codestream.segment[2].spcod), 9) @@ -818,38 +533,16 @@ class TestSuiteWrite(unittest.TestCase): infile = opj_data_file('input/nonregression/Cevennes1.bmp') data = read_image(infile) with tempfile.NamedTemporaryFile(suffix='.j2k') as tfile: - j = Jp2k(tfile.name, 'wb') - j.write(data, cratios=[800]) + j = Jp2k(tfile.name, data=data, cratios=[800]) codestream = j.get_codestream(header_only=False) - # SIZ: Image and tile size - # Profile: "0" means profile 2 - self.assertEqual(codestream.segment[1].rsiz, 0) - # Reference grid size - self.assertEqual((codestream.segment[1].xsiz, - codestream.segment[1].ysiz), - (2592, 1944)) - # Reference grid offset - self.assertEqual((codestream.segment[1].xosiz, - codestream.segment[1].yosiz), (0, 0)) - # Tile size - self.assertEqual((codestream.segment[1].xtsiz, - codestream.segment[1].ytsiz), - (2592, 1944)) - # Tile offset - self.assertEqual((codestream.segment[1].xtosiz, - codestream.segment[1].ytosiz), - (0, 0)) - # bitdepth - self.assertEqual(codestream.segment[1].bitdepth, (8, 8, 8)) - # signed - self.assertEqual(codestream.segment[1].signed, - (False, False, False)) - # subsampling - self.assertEqual(list(zip(codestream.segment[1].xrsiz, - codestream.segment[1].yrsiz)), - [(1, 1)] * 3) + kwargs = {'rsiz': 0, 'xysiz': (2592, 1944), 'xyosiz': (0, 0), + 'xytsiz': (2592, 1944), 'xytosiz': (0, 0), + 'bitdepth': (8, 8, 8), 'signed': (False, False, False), + 'xyrsiz': [(1, 1, 1), (1, 1, 1)]} + self.verifySizSegment(codestream.segment[1], + glymur.codestream.SIZsegment(**kwargs)) # COD: Coding style default self.assertFalse(codestream.segment[2].scod & 2) # no sop @@ -860,18 +553,9 @@ class TestSuiteWrite(unittest.TestCase): self.assertEqual(codestream.segment[2].spcod[4], 5) # levels self.assertEqual(tuple(codestream.segment[2].code_block_size), (64, 64)) # cblksz - # Selective arithmetic coding BYPASS - self.assertFalse(codestream.segment[2].spcod[7] & 0x01) - # RESET context probabilities (RESET) - self.assertFalse(codestream.segment[2].spcod[7] & 0x02) - # Termination on each coding pass, RESTART(TERMALL) - self.assertFalse(codestream.segment[2].spcod[7] & 0x04) - # Vertically causal context (VSC) - self.assertFalse(codestream.segment[2].spcod[7] & 0x08) - # Predictable termination, ERTERM(SEGTERM) - self.assertFalse(codestream.segment[2].spcod[7] & 0x0010) - # Segmentation symbols, SEGMARK(SEGSYSM) - self.assertFalse(codestream.segment[2].spcod[7] & 0x0020) + self.verify_codeblock_style(codestream.segment[2].spcod[7], + [False, False, False, + False, False, False]) self.assertEqual(codestream.segment[2].spcod[8], glymur.core.WAVELET_XFORM_5X3_REVERSIBLE) self.assertEqual(len(codestream.segment[2].spcod), 9) @@ -881,38 +565,16 @@ class TestSuiteWrite(unittest.TestCase): infile = opj_data_file('input/nonregression/Cevennes2.ppm') data = read_image(infile) with tempfile.NamedTemporaryFile(suffix='.j2k') as tfile: - j = Jp2k(tfile.name, 'wb') - j.write(data, cratios=[50]) + j = Jp2k(tfile.name, data=data, cratios=[50]) codestream = j.get_codestream(header_only=False) - # SIZ: Image and tile size - # Profile: "0" means profile 2 - self.assertEqual(codestream.segment[1].rsiz, 0) - # Reference grid size - self.assertEqual((codestream.segment[1].xsiz, - codestream.segment[1].ysiz), - (640, 480)) - # Reference grid offset - self.assertEqual((codestream.segment[1].xosiz, - codestream.segment[1].yosiz), (0, 0)) - # Tile size - self.assertEqual((codestream.segment[1].xtsiz, - codestream.segment[1].ytsiz), - (640, 480)) - # Tile offset - self.assertEqual((codestream.segment[1].xtosiz, - codestream.segment[1].ytosiz), - (0, 0)) - # bitdepth - self.assertEqual(codestream.segment[1].bitdepth, (8, 8, 8)) - # signed - self.assertEqual(codestream.segment[1].signed, - (False, False, False)) - # subsampling - self.assertEqual(list(zip(codestream.segment[1].xrsiz, - codestream.segment[1].yrsiz)), - [(1, 1)] * 3) + kwargs = {'rsiz': 0, 'xysiz': (640, 480), 'xyosiz': (0, 0), + 'xytsiz': (640, 480), 'xytosiz': (0, 0), + 'bitdepth': (8, 8, 8), 'signed': (False, False, False), + 'xyrsiz': [(1, 1, 1), (1, 1, 1)]} + self.verifySizSegment(codestream.segment[1], + glymur.codestream.SIZsegment(**kwargs)) # COD: Coding style default self.assertFalse(codestream.segment[2].scod & 2) # no sop @@ -923,18 +585,9 @@ class TestSuiteWrite(unittest.TestCase): self.assertEqual(codestream.segment[2].spcod[4], 5) # levels self.assertEqual(tuple(codestream.segment[2].code_block_size), (64, 64)) # cblksz - # Selective arithmetic coding BYPASS - self.assertFalse(codestream.segment[2].spcod[7] & 0x01) - # RESET context probabilities (RESET) - self.assertFalse(codestream.segment[2].spcod[7] & 0x02) - # Termination on each coding pass, RESTART(TERMALL) - self.assertFalse(codestream.segment[2].spcod[7] & 0x04) - # Vertically causal context (VSC) - self.assertFalse(codestream.segment[2].spcod[7] & 0x08) - # Predictable termination, ERTERM(SEGTERM) - self.assertFalse(codestream.segment[2].spcod[7] & 0x0010) - # Segmentation symbols, SEGMARK(SEGSYSM) - self.assertFalse(codestream.segment[2].spcod[7] & 0x0020) + self.verify_codeblock_style(codestream.segment[2].spcod[7], + [False, False, False, + False, False, False]) self.assertEqual(codestream.segment[2].spcod[8], glymur.core.WAVELET_XFORM_5X3_REVERSIBLE) self.assertEqual(len(codestream.segment[2].spcod), 9) @@ -943,8 +596,8 @@ class TestSuiteWrite(unittest.TestCase): """NR-ENC-Rome.bmp-11-encode""" data = read_image(opj_data_file('input/nonregression/Rome.bmp')) with tempfile.NamedTemporaryFile(suffix='.jp2') as tfile: - jp2 = Jp2k(tfile.name, 'wb') - jp2.write(data, psnr=[30, 35, 50], prog='LRCP', numres=3) + jp2 = Jp2k(tfile.name, + data=data, psnr=[30, 35, 50], prog='LRCP', numres=3) ids = [box.box_id for box in jp2.box] self.assertEqual(ids, ['jP ', 'ftyp', 'jp2h', 'jp2c']) @@ -979,36 +632,14 @@ class TestSuiteWrite(unittest.TestCase): self.assertIsNone(jp2.box[2].box[1].icc_profile) self.assertEqual(jp2.box[2].box[1].colorspace, glymur.core.SRGB) - codestream = jp2.box[3].main_header + codestream = jp2.box[3].codestream - # SIZ: Image and tile size - # Profile: "0" means profile 2 - self.assertEqual(codestream.segment[1].rsiz, 0) - # Reference grid size - self.assertEqual((codestream.segment[1].xsiz, - codestream.segment[1].ysiz), - (640, 480)) - # Reference grid offset - self.assertEqual((codestream.segment[1].xosiz, - codestream.segment[1].yosiz), - (0, 0)) - # Tile size - self.assertEqual((codestream.segment[1].xtsiz, - codestream.segment[1].ytsiz), - (640, 480)) - # Tile offset - self.assertEqual((codestream.segment[1].xtosiz, - codestream.segment[1].ytosiz), - (0, 0)) - # bitdepth - self.assertEqual(codestream.segment[1].bitdepth, (8, 8, 8)) - # signed - self.assertEqual(codestream.segment[1].signed, - (False, False, False)) - # subsampling - self.assertEqual(list(zip(codestream.segment[1].xrsiz, - codestream.segment[1].yrsiz)), - [(1, 1)] * 3) + kwargs = {'rsiz': 0, 'xysiz': (640, 480), 'xyosiz': (0, 0), + 'xytsiz': (640, 480), 'xytosiz': (0, 0), + 'bitdepth': (8, 8, 8), 'signed': (False, False, False), + 'xyrsiz': [(1, 1, 1), (1, 1, 1)]} + self.verifySizSegment(codestream.segment[1], + glymur.codestream.SIZsegment(**kwargs)) # COD: Coding style default self.assertFalse(codestream.segment[2].scod & 2) # no sop @@ -1019,18 +650,9 @@ class TestSuiteWrite(unittest.TestCase): self.assertEqual(codestream.segment[2].spcod[4], 2) # levels self.assertEqual(tuple(codestream.segment[2].code_block_size), (64, 64)) # cblksz - # Selective arithmetic coding BYPASS - self.assertFalse(codestream.segment[2].spcod[7] & 0x01) - # RESET context probabilities (RESET) - self.assertFalse(codestream.segment[2].spcod[7] & 0x02) - # Termination on each coding pass, RESTART(TERMALL) - self.assertFalse(codestream.segment[2].spcod[7] & 0x04) - # Vertically causal context (VSC) - self.assertFalse(codestream.segment[2].spcod[7] & 0x08) - # Predictable termination, ERTERM(SEGTERM) - self.assertFalse(codestream.segment[2].spcod[7] & 0x0010) - # Segmentation symbols, SEGMARK(SEGSYSM) - self.assertFalse(codestream.segment[2].spcod[7] & 0x0020) + self.verify_codeblock_style(codestream.segment[2].spcod[7], + [False, False, False, + False, False, False]) self.assertEqual(codestream.segment[2].spcod[8], glymur.core.WAVELET_XFORM_5X3_REVERSIBLE) self.assertEqual(len(codestream.segment[2].spcod), 9) @@ -1042,37 +664,16 @@ class TestSuiteWrite(unittest.TestCase): infile = opj_data_file('input/nonregression/random-issue-0005.tif') data = read_image(infile) with tempfile.NamedTemporaryFile(suffix='.j2k') as tfile: - j = Jp2k(tfile.name, 'wb') - j.write(data) + j = Jp2k(tfile.name, data=data) codestream = j.get_codestream(header_only=False) - # SIZ: Image and tile size - # Profile: "0" means profile 2 - self.assertEqual(codestream.segment[1].rsiz, 0) - # Reference grid size - self.assertEqual((codestream.segment[1].xsiz, - codestream.segment[1].ysiz), - (1024, 1024)) - # Reference grid offset - self.assertEqual((codestream.segment[1].xosiz, - codestream.segment[1].yosiz), (0, 0)) - # Tile size - self.assertEqual((codestream.segment[1].xtsiz, - codestream.segment[1].ytsiz), - (1024, 1024)) - # Tile offset - self.assertEqual((codestream.segment[1].xtosiz, - codestream.segment[1].ytosiz), - (0, 0)) - # bitdepth - self.assertEqual(codestream.segment[1].bitdepth, (16,)) - # signed - self.assertEqual(codestream.segment[1].signed, (False,)) - # subsampling - self.assertEqual(list(zip(codestream.segment[1].xrsiz, - codestream.segment[1].yrsiz)), - [(1, 1)]) + kwargs = {'rsiz': 0, 'xysiz': (1024, 1024), 'xyosiz': (0, 0), + 'xytsiz': (1024, 1024), 'xytosiz': (0, 0), + 'bitdepth': (16,), 'signed': (False,), + 'xyrsiz': [(1,), (1,)]} + self.verifySizSegment(codestream.segment[1], + glymur.codestream.SIZsegment(**kwargs)) # COD: Coding style default self.assertFalse(codestream.segment[2].scod & 2) # no sop @@ -1083,18 +684,9 @@ class TestSuiteWrite(unittest.TestCase): self.assertEqual(codestream.segment[2].spcod[4], 5) # levels self.assertEqual(tuple(codestream.segment[2].code_block_size), (64, 64)) # cblksz - # Selective arithmetic coding BYPASS - self.assertFalse(codestream.segment[2].spcod[7] & 0x01) - # RESET context probabilities (RESET) - self.assertFalse(codestream.segment[2].spcod[7] & 0x02) - # Termination on each coding pass, RESTART(TERMALL) - self.assertFalse(codestream.segment[2].spcod[7] & 0x04) - # Vertically causal context (VSC) - self.assertFalse(codestream.segment[2].spcod[7] & 0x08) - # Predictable termination, ERTERM(SEGTERM) - self.assertFalse(codestream.segment[2].spcod[7] & 0x0010) - # Segmentation symbols, SEGMARK(SEGSYSM) - self.assertFalse(codestream.segment[2].spcod[7] & 0x0020) + self.verify_codeblock_style(codestream.segment[2].spcod[7], + [False, False, False, + False, False, False]) self.assertEqual(codestream.segment[2].spcod[8], glymur.core.WAVELET_XFORM_5X3_REVERSIBLE) self.assertEqual(len(codestream.segment[2].spcod), 9) diff --git a/glymur/test/test_printing.py b/glymur/test/test_printing.py index efd1ccf..bccaa00 100644 --- a/glymur/test/test_printing.py +++ b/glymur/test/test_printing.py @@ -1,20 +1,11 @@ # -*- coding: utf-8 -*- """Test suite for printing. """ -# C0302: don't care too much about having too many lines in a test module -# pylint: disable=C0302 - -# E061: unittest.mock introduced in 3.3 (python-2.7/pylint issue) -# pylint: disable=E0611,F0401 - -# R0904: Not too many methods in unittest. -# pylint: disable=R0904 - import os +import re import struct import sys import tempfile -import warnings import unittest if sys.hexversion < 0x03000000: @@ -30,13 +21,16 @@ else: import lxml.etree as ET import glymur -from glymur import Jp2k +from glymur import Jp2k, command_line from . import fixtures -from .fixtures import OPJ_DATA_ROOT, opj_data_file -from .fixtures import text_gbr_27, text_gbr_33, text_gbr_34 +from .fixtures import (OPJ_DATA_ROOT, opj_data_file, + WARNING_INFRASTRUCTURE_ISSUE, + WARNING_INFRASTRUCTURE_MSG, + WINDOWS_TMP_FILE_MSG, + text_gbr_27, text_gbr_33, text_gbr_34) -@unittest.skipIf(os.name == "nt", "Temporary file issue on window.") +@unittest.skipIf(os.name == "nt", WINDOWS_TMP_FILE_MSG) class TestPrinting(unittest.TestCase): """Tests for verifying how printing works.""" def setUp(self): @@ -48,35 +42,24 @@ class TestPrinting(unittest.TestCase): glymur.set_printoptions(short=False, xml=True, codestream=True) def tearDown(self): - pass - - def test_codestream(self): - """Should be able to print a raw codestream.""" - j = glymur.Jp2k(self.j2kfile) - with patch('sys.stdout', new=StringIO()) as fake_out: - print(j) - actual = fake_out.getvalue().strip() - # Remove the file line, as that is filesystem-dependent. - lines = actual.split('\n') - actual = '\n'.join(lines[1:]) - - self.assertEqual(actual, fixtures.codestream) + glymur.set_parseoptions(full_codestream=False) def test_version_info(self): """Should be able to print(glymur.version.info)""" with patch('sys.stdout', new=StringIO()) as fake_out: print(glymur.version.info) - actual = fake_out.getvalue().strip() + fake_out.getvalue().strip() self.assertTrue(True) + @unittest.skipIf(WARNING_INFRASTRUCTURE_ISSUE, WARNING_INFRASTRUCTURE_MSG) def test_unknown_superbox(self): """Verify that we can handle an unknown superbox.""" with tempfile.NamedTemporaryFile(suffix='.jpx') as tfile: with open(self.jpxfile, 'rb') as ifile: tfile.write(ifile.read()) - - # Add the header for an unknwon superbox. + + # Add the header for an unknown superbox. write_buffer = struct.pack('>I4s', 20, 'grp '.encode()) tfile.write(write_buffer) @@ -86,10 +69,8 @@ class TestPrinting(unittest.TestCase): tfile.write(write_buffer) tfile.flush() - with warnings.catch_warnings(record=True) as w: - warnings.simplefilter('always') + with self.assertWarns(UserWarning): jpx = Jp2k(tfile.name) - self.assertTrue(len(w), 1) glymur.set_printoptions(short=True) with patch('sys.stdout', new=StringIO()) as fake_out: @@ -106,84 +87,17 @@ class TestPrinting(unittest.TestCase): with self.assertRaises(TypeError): glymur.set_printoptions(hi='low') - def test_propts_no_codestream_then_no_xml(self): - """Verify printed output when codestream=False and xml=False, #162""" - # The print options should be persistent across invocations. - glymur.set_printoptions(codestream=False) - glymur.set_printoptions(xml=False) - with patch('sys.stdout', new=StringIO()) as fake_out: - glymur.jp2dump(self.jp2file) - actual = fake_out.getvalue().strip() - - # Get rid of the filename line, as it is not set in stone. - lst = actual.split('\n') - lst = lst[1:] - actual = '\n'.join(lst) - self.assertEqual(actual, fixtures.nemo_dump_no_codestream_no_xml) - - def test_printopt_no_codestr_or_xml(self): - """Verify printed output when codestream=False and xml=False""" - glymur.set_printoptions(codestream=False, xml=False) - with patch('sys.stdout', new=StringIO()) as fake_out: - glymur.jp2dump(self.jp2file) - actual = fake_out.getvalue().strip() - - # Get rid of the filename line, as it is not set in stone. - lst = actual.split('\n') - lst = lst[1:] - actual = '\n'.join(lst) - self.assertEqual(actual, fixtures.nemo_dump_no_codestream_no_xml) - - def test_printoptions_no_codestream(self): - """Verify printed output when codestream=False""" - glymur.set_printoptions(codestream=False) - with patch('sys.stdout', new=StringIO()) as fake_out: - glymur.jp2dump(self.jp2file) - actual = fake_out.getvalue().strip() - - # Get rid of the filename line, as it is not set in stone. - lst = actual.split('\n') - lst = lst[1:] - actual = '\n'.join(lst) - self.assertEqual(actual, fixtures.nemo_dump_no_codestream) - - def test_printoptions_no_xml(self): - """Verify printed output when xml=False""" - glymur.set_printoptions(xml=False) - with patch('sys.stdout', new=StringIO()) as fake_out: - glymur.jp2dump(self.jp2file) - actual = fake_out.getvalue().strip() - - # Get rid of the filename line, as it is not set in stone. - lst = actual.split('\n') - lst = lst[1:] - actual = '\n'.join(lst) - expected = fixtures.nemo_dump_no_xml - self.assertEqual(actual, expected) - - def test_printoptions_short(self): - """Verify printed output when short=True""" - glymur.set_printoptions(short=True) - with patch('sys.stdout', new=StringIO()) as fake_out: - glymur.jp2dump(self.jp2file) - actual = fake_out.getvalue().strip() - - # Get rid of the filename line, as it is not set in stone. - lst = actual.split('\n') - lst = lst[1:] - actual = '\n'.join(lst) - self.assertEqual(actual, fixtures.nemo_dump_short) - + @unittest.skipIf(re.match("1.5|2", + glymur.version.openjpeg_version) is None, + "Must have openjpeg 1.5 or higher to run") def test_asoc_label_box(self): """verify printing of asoc, label boxes""" # Construct a fake file with an asoc and a label box, as # OpenJPEG doesn't have such a file. - data = glymur.Jp2k(self.jp2file).read(rlevel=1) + data = glymur.Jp2k(self.jp2file)[::2, ::2] with tempfile.NamedTemporaryFile(suffix='.jp2') as tfile: - j = glymur.Jp2k(tfile.name, 'wb') - j.write(data) - with tempfile.NamedTemporaryFile(suffix='.jp2') as tfile2: + glymur.Jp2k(tfile.name, data=data) # Offset of the codestream is where we start. wbuffer = tfile.read(77) @@ -227,32 +141,6 @@ class TestPrinting(unittest.TestCase): expected = '\n'.join(lines) self.assertEqual(actual, expected) - def test_jp2dump(self): - """basic jp2dump test""" - with patch('sys.stdout', new=StringIO()) as fake_out: - glymur.jp2dump(self.jp2file) - actual = fake_out.getvalue().strip() - - # Get rid of the filename line, as it is not set in stone. - lst = actual.split('\n') - lst = lst[1:] - actual = '\n'.join(lst) - self.assertEqual(actual, fixtures.nemo_dump_full) - - def test_entire_file(self): - """verify output from printing entire file""" - j = glymur.Jp2k(self.jp2file) - with patch('sys.stdout', new=StringIO()) as fake_out: - print(j) - actual = fake_out.getvalue().strip() - - # Get rid of the filename line, as it is not set in stone. - lst = actual.split('\n') - lst = lst[1:] - actual = '\n'.join(lst) - - self.assertEqual(actual, fixtures.nemo_dump_full) - def test_coc_segment(self): """verify printing of COC segment""" j = glymur.Jp2k(self.jp2file) @@ -511,7 +399,7 @@ class TestPrinting(unittest.TestCase): @unittest.skipIf(sys.hexversion < 0x03000000, "Only trusting python3 for printing non-ascii chars") def test_xml_cyrrilic(self): - """Should be able to print an XMLBox with utf-8 encoding (cyrrillic).""" + """Should be able to print XMLBox with utf-8 encoding (cyrrillic).""" # Seems to be inconsistencies between different versions of python2.x # as to what gets printed. # @@ -529,7 +417,8 @@ class TestPrinting(unittest.TestCase): actual = fake_out.getvalue().strip() if sys.hexversion < 0x03000000: lines = ["XML Box (xml ) @ (-1, 0)", - " Россия"] + (" Росс", + "ия")] else: lines = ["XML Box (xml ) @ (-1, 0)", " Россия"] @@ -705,7 +594,8 @@ class TestPrinting(unittest.TestCase): lines = ["UUID Box (uuid) @ (1135519, 76)", " UUID: 4a706754-6966-6645-7869-662d3e4a5032 (EXIF)", - " UUID Data: OrderedDict([('ImageWidth', 256), ('ImageLength', 512), ('Make', 'HTC')])"] + (" UUID Data: OrderedDict([('ImageWidth', 256)," + " ('ImageLength', 512), ('Make', 'HTC')])")] expected = '\n'.join(lines) @@ -725,8 +615,6 @@ class TestPrintingOpjDataRoot(unittest.TestCase): # Reset printoptions for every test. glymur.set_printoptions(short=False, xml=True, codestream=True) - warnings.resetwarnings() - def tearDown(self): pass @@ -740,45 +628,6 @@ class TestPrintingOpjDataRoot(unittest.TestCase): actual = fake_out.getvalue().strip() self.assertEqual(actual, fixtures.cinema2k_profile) - def test_invalid_colorspace(self): - """An invalid colorspace shouldn't cause an error.""" - filename = opj_data_file('input/nonregression/edf_c2_1103421.jp2') - with warnings.catch_warnings(): - warnings.simplefilter("ignore") - jp2 = Jp2k(filename) - with patch('sys.stdout', new=StringIO()) as fake_out: - print(jp2) - - def test_bad_rsiz(self): - """Should still be able to print if rsiz is bad, issue196""" - filename = opj_data_file('input/nonregression/edf_c2_1002767.jp2') - with warnings.catch_warnings(): - warnings.simplefilter("ignore") - j = Jp2k(filename) - with patch('sys.stdout', new=StringIO()) as fake_out: - print(j) - - def test_bad_wavelet_transform(self): - """Should still be able to print if wavelet xform is bad, issue195""" - filename = opj_data_file('input/nonregression/edf_c2_10025.jp2') - with warnings.catch_warnings(): - warnings.simplefilter("ignore") - j = Jp2k(filename) - with patch('sys.stdout', new=StringIO()) as fake_out: - print(j) - - def test_invalid_progression_order(self): - """Should still be able to print even if prog order is invalid.""" - jfile = opj_data_file('input/nonregression/2977.pdf.asan.67.2198.jp2') - with warnings.catch_warnings(): - warnings.simplefilter("ignore") - jp2 = Jp2k(jfile) - codestream = jp2.get_codestream() - with patch('sys.stdout', new=StringIO()) as fake_out: - print(codestream.segment[2]) - actual = fake_out.getvalue().strip() - self.assertEqual(actual, fixtures.issue_186_progression_order) - def test_crg(self): """verify printing of CRG segment""" filename = opj_data_file('input/conformance/p0_03.j2k') @@ -928,46 +777,6 @@ class TestPrintingOpjDataRoot(unittest.TestCase): expected = '\n'.join(lines) self.assertEqual(actual, expected) - def test_xml(self): - """verify printing of XML box""" - filename = opj_data_file('input/conformance/file1.jp2') - j = glymur.Jp2k(filename) - with patch('sys.stdout', new=StringIO()) as fake_out: - print(j.box[2]) - actual = fake_out.getvalue().strip() - self.assertEqual(actual, fixtures.file1_xml) - - def test_channel_definition(self): - """verify printing of cdef box""" - filename = opj_data_file('input/conformance/file2.jp2') - with warnings.catch_warnings(): - # Bad compatibility list item. - warnings.simplefilter("ignore") - j = glymur.Jp2k(filename) - with patch('sys.stdout', new=StringIO()) as fake_out: - print(j.box[2].box[2]) - actual = fake_out.getvalue().strip() - lines = ['Channel Definition Box (cdef) @ (81, 28)', - ' Channel 0 (color) ==> (3)', - ' Channel 1 (color) ==> (2)', - ' Channel 2 (color) ==> (1)'] - expected = '\n'.join(lines) - self.assertEqual(actual, expected) - - def test_component_mapping(self): - """verify printing of cmap box""" - filename = opj_data_file('input/conformance/file9.jp2') - j = glymur.Jp2k(filename) - with patch('sys.stdout', new=StringIO()) as fake_out: - print(j.box[2].box[2]) - actual = fake_out.getvalue().strip() - lines = ['Component Mapping Box (cmap) @ (848, 20)', - ' Component 0 ==> palette column 0', - ' Component 0 ==> palette column 1', - ' Component 0 ==> palette column 2'] - expected = '\n'.join(lines) - self.assertEqual(actual, expected) - def test_componentmapping_box_alpha(self): """Verify __repr__ method on cmap box.""" cmap = glymur.jp2box.ComponentMappingBox(component_index=(0, 0, 0), @@ -979,27 +788,6 @@ class TestPrintingOpjDataRoot(unittest.TestCase): self.assertEqual(newbox.mapping_type, (1, 1, 1)) self.assertEqual(newbox.palette_index, (0, 1, 2)) - def test_palette7(self): - """verify printing of pclr box""" - filename = opj_data_file('input/conformance/file9.jp2') - j = glymur.Jp2k(filename) - with patch('sys.stdout', new=StringIO()) as fake_out: - print(j.box[2].box[1]) - actual = fake_out.getvalue().strip() - lines = ['Palette Box (pclr) @ (66, 782)', - ' Size: (256 x 3)'] - expected = '\n'.join(lines) - self.assertEqual(actual, expected) - - def test_rreq(self): - """verify printing of reader requirements box""" - filename = opj_data_file('input/nonregression/text_GBR.jp2') - j = glymur.Jp2k(filename) - with patch('sys.stdout', new=StringIO()) as fake_out: - print(j.box[2]) - actual = fake_out.getvalue().strip() - self.assertEqual(actual, fixtures.text_GBR_rreq) - def test_differing_subsamples(self): """verify printing of SIZ with different subsampling... Issue 86.""" filename = opj_data_file('input/conformance/p0_05.j2k') @@ -1021,10 +809,144 @@ class TestPrintingOpjDataRoot(unittest.TestCase): expected = '\n'.join(lines) self.assertEqual(actual, expected) + +@unittest.skipIf(OPJ_DATA_ROOT is None, + "OPJ_DATA_ROOT environment variable not set") +@unittest.skipIf(os.name == "nt", "Temporary file issue on window.") +@unittest.skipIf(WARNING_INFRASTRUCTURE_ISSUE, WARNING_INFRASTRUCTURE_MSG) +class TestPrintingOpjDataRootWarns(unittest.TestCase): + """ + Tests for verifying printing. restricted to OPJ_DATA_ROOT files. + + These tests issue warnings. + """ + def setUp(self): + self.jpxfile = glymur.data.jpxfile() + self.jp2file = glymur.data.nemo() + self.j2kfile = glymur.data.goodstuff() + + # Reset printoptions for every test. + glymur.set_printoptions(short=False, xml=True, codestream=True) + + def tearDown(self): + pass + + def test_invalid_colour_specification_method(self): + """should not error out with invalid colour specification method""" + # Don't care so much about what the output looks like, just that we + # do not error out. + filename = opj_data_file('input/nonregression/issue397.jp2') + with self.assertWarns(UserWarning): + jp2 = Jp2k(filename) + with patch('sys.stdout', new=StringIO()): + print(jp2) + self.assertTrue(True) + + def test_invalid_colorspace(self): + """An invalid colorspace shouldn't cause an error.""" + filename = opj_data_file('input/nonregression/edf_c2_1103421.jp2') + with self.assertWarns(UserWarning): + jp2 = Jp2k(filename) + with patch('sys.stdout', new=StringIO()): + print(jp2) + + def test_bad_rsiz(self): + """Should still be able to print if rsiz is bad, issue196""" + filename = opj_data_file('input/nonregression/edf_c2_1002767.jp2') + with self.assertWarns(UserWarning): + j = Jp2k(filename).get_codestream() + with patch('sys.stdout', new=StringIO()): + print(j) + + def test_bad_wavelet_transform(self): + """Should still be able to print if wavelet xform is bad, issue195""" + filename = opj_data_file('input/nonregression/edf_c2_10025.jp2') + with self.assertWarns(UserWarning): + jp2 = Jp2k(filename) + with patch('sys.stdout', new=StringIO()): + print(jp2) + + def test_invalid_progression_order(self): + """Should still be able to print even if prog order is invalid.""" + jfile = opj_data_file('input/nonregression/2977.pdf.asan.67.2198.jp2') + with self.assertWarns(UserWarning): + # Multiple warnings, actually. + jp2 = Jp2k(jfile) + codestream = jp2.get_codestream() + with patch('sys.stdout', new=StringIO()) as fake_out: + print(codestream.segment[2]) + actual = fake_out.getvalue().strip() + self.assertEqual(actual, fixtures.issue_186_progression_order) + + def test_xml(self): + """verify printing of XML box""" + filename = opj_data_file('input/conformance/file1.jp2') + with self.assertWarns(UserWarning): + j = glymur.Jp2k(filename) + with patch('sys.stdout', new=StringIO()) as fake_out: + print(j.box[2]) + actual = fake_out.getvalue().strip() + self.assertEqual(actual, fixtures.file1_xml) + + def test_channel_definition(self): + """verify printing of cdef box""" + filename = opj_data_file('input/conformance/file2.jp2') + with self.assertWarns(UserWarning): + # Bad compatibility list item. + j = glymur.Jp2k(filename) + with patch('sys.stdout', new=StringIO()) as fake_out: + print(j.box[2].box[2]) + actual = fake_out.getvalue().strip() + lines = ['Channel Definition Box (cdef) @ (81, 28)', + ' Channel 0 (color) ==> (3)', + ' Channel 1 (color) ==> (2)', + ' Channel 2 (color) ==> (1)'] + expected = '\n'.join(lines) + self.assertEqual(actual, expected) + + def test_component_mapping(self): + """verify printing of cmap box""" + filename = opj_data_file('input/conformance/file9.jp2') + with self.assertWarns(UserWarning): + j = glymur.Jp2k(filename) + with patch('sys.stdout', new=StringIO()) as fake_out: + print(j.box[2].box[2]) + actual = fake_out.getvalue().strip() + lines = ['Component Mapping Box (cmap) @ (848, 20)', + ' Component 0 ==> palette column 0', + ' Component 0 ==> palette column 1', + ' Component 0 ==> palette column 2'] + expected = '\n'.join(lines) + self.assertEqual(actual, expected) + + def test_palette7(self): + """verify printing of pclr box""" + filename = opj_data_file('input/conformance/file9.jp2') + with self.assertWarns(UserWarning): + j = glymur.Jp2k(filename) + with patch('sys.stdout', new=StringIO()) as fake_out: + print(j.box[2].box[1]) + actual = fake_out.getvalue().strip() + lines = ['Palette Box (pclr) @ (66, 782)', + ' Size: (256 x 3)'] + expected = '\n'.join(lines) + self.assertEqual(actual, expected) + + def test_rreq(self): + """verify printing of reader requirements box""" + filename = opj_data_file('input/nonregression/text_GBR.jp2') + with self.assertWarns(UserWarning): + j = glymur.Jp2k(filename) + with patch('sys.stdout', new=StringIO()) as fake_out: + print(j.box[2]) + actual = fake_out.getvalue().strip() + self.assertEqual(actual, fixtures.text_GBR_rreq) + def test_palette_box(self): """Verify that palette (pclr) boxes are printed without error.""" filename = opj_data_file('input/conformance/file9.jp2') - j = glymur.Jp2k(filename) + with self.assertWarns(UserWarning): + j = glymur.Jp2k(filename) with patch('sys.stdout', new=StringIO()) as fake_out: print(j.box[2].box[1]) actual = fake_out.getvalue().strip() @@ -1038,9 +960,8 @@ class TestPrintingOpjDataRoot(unittest.TestCase): # ICC profiles may be used in JP2, but the approximation field should # be zero unless we have jpx. This file does both. filename = opj_data_file('input/nonregression/text_GBR.jp2') - with warnings.catch_warnings(): + with self.assertWarns(UserWarning): # brand is 'jp2 ', but has any icc profile. - warnings.simplefilter("ignore") jp2 = Jp2k(filename) with patch('sys.stdout', new=StringIO()) as fake_out: @@ -1058,9 +979,7 @@ class TestPrintingOpjDataRoot(unittest.TestCase): def test_uuid(self): """verify printing of UUID box""" filename = opj_data_file('input/nonregression/text_GBR.jp2') - with warnings.catch_warnings(): - # brand is 'jp2 ', but has any icc profile. - warnings.simplefilter("ignore") + with self.assertWarns(UserWarning): jp2 = Jp2k(filename) with patch('sys.stdout', new=StringIO()) as fake_out: @@ -1079,9 +998,8 @@ class TestPrintingOpjDataRoot(unittest.TestCase): # Format strings like %d were showing up in the output. filename = opj_data_file('input/nonregression/mem-b2ace68c-1381.jp2') - with warnings.catch_warnings(): + with self.assertWarns(UserWarning): # Ignore warning about bad pclr box. - warnings.simplefilter("ignore") jp2 = Jp2k(filename) with patch('sys.stdout', new=StringIO()) as fake_out: print(jp2.box[3].box[3]) @@ -1091,9 +1009,8 @@ class TestPrintingOpjDataRoot(unittest.TestCase): def test_issue183(self): filename = opj_data_file('input/nonregression/orb-blue10-lin-jp2.jp2') - with warnings.catch_warnings(): + with self.assertWarns(UserWarning): # Ignore warning about bad pclr box. - warnings.simplefilter("ignore") jp2 = Jp2k(filename) with patch('sys.stdout', new=StringIO()) as fake_out: print(jp2.box[2].box[1]) @@ -1105,14 +1022,114 @@ class TestPrintingOpjDataRoot(unittest.TestCase): filename = opj_data_file(os.path.join('input', 'nonregression', 'issue171.jp2')) - with warnings.catch_warnings(): - warnings.simplefilter("ignore") + with self.assertWarns(UserWarning): jp2 = Jp2k(filename) - with patch('sys.stdout', new=StringIO()) as fake_out: + with patch('sys.stdout', new=StringIO()): # No need to verify, it's enough that we don't error out. print(jp2) self.assertTrue(True) -if __name__ == "__main__": - unittest.main() + +class TestJp2dump(unittest.TestCase): + """Tests for verifying how jp2dump console script works.""" + def setUp(self): + self.jpxfile = glymur.data.jpxfile() + self.jp2file = glymur.data.nemo() + self.j2kfile = glymur.data.goodstuff() + + # Reset printoptions for every test. + glymur.set_printoptions(short=False, xml=True, codestream=True) + glymur.set_parseoptions(full_codestream=False) + + def tearDown(self): + glymur.set_parseoptions(full_codestream=False) + + def run_jp2dump(self, args): + sys.argv = args + with patch('sys.stdout', new=StringIO()) as fake_out: + command_line.main() + actual = fake_out.getvalue().strip() + # Remove the file line, as that is filesystem-dependent. + lines = actual.split('\n') + actual = '\n'.join(lines[1:]) + return actual + + def test_default_nemo(self): + """by default one should get the main header""" + actual = self.run_jp2dump(['', self.jp2file]) + + # shave off the non-main-header segments + lines = fixtures.nemo.split('\n') + expected = lines[0:140] + expected = '\n'.join(expected) + self.assertEqual(actual, expected) + + def test_jp2_codestream_0(self): + """Verify dumping with -c 0, supressing all codestream details.""" + actual = self.run_jp2dump(['', '-c', '0', self.jp2file]) + + # shave off the codestream details + lines = fixtures.nemo.split('\n') + expected = lines[0:105] + expected = '\n'.join(expected) + self.assertEqual(actual, expected) + + def test_jp2_codestream_1(self): + """Verify dumping with -c 1, print just the header.""" + actual = self.run_jp2dump(['', '-c', '1', self.jp2file]) + + # shave off the non-main-header segments + lines = fixtures.nemo.split('\n') + expected = lines[0:140] + expected = '\n'.join(expected) + self.assertEqual(actual, expected) + + def test_jp2_codestream_2(self): + """Verify dumping with -c 2, print entire jp2 jacket, codestream.""" + actual = self.run_jp2dump(['', '-c', '2', self.jp2file]) + + # shave off the non-main-header segments + expected = fixtures.nemo + self.assertEqual(actual, expected) + + @unittest.skipIf(sys.hexversion < 0x03000000, "assertRegex not in 2.7") + def test_j2k_codestream_0(self): + """-c 0 should print just a single line when used on a codestream.""" + sys.argv = ['', '-c', '0', self.j2kfile] + with patch('sys.stdout', new=StringIO()) as fake_out: + command_line.main() + actual = fake_out.getvalue().strip() + self.assertRegex(actual, "File: .*") + + def test_j2k_codestream_2(self): + """Verify dumping with -c 2, full details.""" + with patch('sys.stdout', new=StringIO()) as fake_out: + sys.argv = ['', '-c', '2', self.j2kfile] + command_line.main() + actual = fake_out.getvalue().strip() + + self.assertIn(fixtures.goodstuff_with_full_header, actual) + + def test_codestream_invalid(self): + """Verify dumping with -c 3, not allowd.""" + with self.assertRaises(ValueError): + sys.argv = ['', '-c', '3', self.jp2file] + command_line.main() + + def test_short(self): + """Verify dumping with -s, short option.""" + actual = self.run_jp2dump(['', '-s', self.jp2file]) + + self.assertEqual(actual, fixtures.nemo_dump_short) + + def test_suppress_xml(self): + """Verify dumping with -x, suppress XML.""" + actual = self.run_jp2dump(['', '-x', self.jp2file]) + + # shave off the XML and non-main-header segments + lines = fixtures.nemo.split('\n') + expected = lines[0:18] + expected.extend(lines[104:140]) + expected = '\n'.join(expected) + self.assertEqual(actual, expected) diff --git a/glymur/version.py b/glymur/version.py index 8ffd80f..4096ee5 100644 --- a/glymur/version.py +++ b/glymur/version.py @@ -14,12 +14,11 @@ from distutils.version import LooseVersion import lxml.etree import numpy as np -from .lib import openjpeg as opj -from .lib import openjp2 as opj2 +from .lib import openjpeg as opj, openjp2 as opj2 # Do not change the format of this next line! Doing so risks breaking # setup.py -version = "0.6.0" +version = "0.8.0" _sv = LooseVersion(version) version_tuple = _sv.version diff --git a/setup.py b/setup.py index 94d692e..b49ed69 100644 --- a/setup.py +++ b/setup.py @@ -1,9 +1,9 @@ -from setuptools import setup, find_packages +from setuptools import setup import os import re import sys -kwargs = {'name': 'glymur', +kwargs = {'name': 'Glymur', 'description': 'Tools for accessing JPEG2000 files', 'long_description': open('README.md').read(), 'author': 'John Evans', @@ -11,16 +11,20 @@ kwargs = {'name': 'glymur', 'url': 'https://github.com/quintusdias/glymur', 'packages': ['glymur', 'glymur.data', 'glymur.test', 'glymur.lib', 'glymur.lib.test'], - 'package_data': {'glymur': ['data/*.jp2', 'data/*.j2k', 'data/*.jpx']}, - 'scripts': ['bin/jp2dump'], + 'package_data': {'glymur': ['data/*.jp2', + 'data/*.j2k', + 'data/*.jpx']}, + 'entry_points': { + 'console_scripts': ['jp2dump=glymur.command_line:main'], + }, 'license': 'MIT', 'test_suite': 'glymur.test'} -instllrqrs = ['numpy>=1.4.1', 'lxml>=2.3.2'] +install_requires = ['numpy>=1.7.0', 'lxml>=3.0.0'] if sys.hexversion < 0x03030000: - instllrqrs.append('contextlib2>=0.4') - instllrqrs.append('mock>=1.0.1') -kwargs['install_requires'] = instllrqrs + install_requires.append('contextlib2>=0.4') + install_requires.append('mock>=1.0.1') +kwargs['install_requires'] = install_requires clssfrs = ["Programming Language :: Python", "Programming Language :: Python :: 2.7",