#!/usr/bin/env python
# -*- coding: utf-8 -*-
###############################################################################
# $Id: ingr.py 33793 2016-03-26 13:02:07Z goatbar $
#
# Project:  GDAL/OGR Test Suite
# Purpose:  Test read/write functionality for INGR.
# Author:   Frank Warmerdam <warmerdam@pobox.com>
#
###############################################################################
# Copyright (c) 2007, Frank Warmerdam <warmerdam@pobox.com>
# Copyright (c) 2008-2013, Even Rouault <even dot rouault at mines-paris dot org>
#
# Permission is hereby granted, free of charge, to any person obtaining a
# copy of this software and associated documentation files (the "Software"),
# to deal in the Software without restriction, including without limitation
# the rights to use, copy, modify, merge, publish, distribute, sublicense,
# and/or sell copies of the Software, and to permit persons to whom the
# Software is furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included
# in all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
# OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
# THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
# DEALINGS IN THE SOFTWARE.
###############################################################################

import os
import sys
from osgeo import gdal

sys.path.append( '../pymod' )

import gdaltest

###############################################################################
# Read test of byte file.

def ingr_1():

    tst = gdaltest.GDALTest( 'INGR', '8bit_rgb.cot', 2, 4855 )
    return tst.testOpen()

###############################################################################
# Read uint32 file.

def ingr_2():

    tst = gdaltest.GDALTest( 'INGR', 'uint32.cot', 1, 4672 )
    return tst.testOpen()

###############################################################################
# Test paletted file, including checking the palette (format 02 I think).

def ingr_3():

    tst = gdaltest.GDALTest( 'INGR', '8bit_pal.cot', 1, 4855 )
    result = tst.testOpen()
    if result != 'success':
        return result

    ds = gdal.Open( 'data/8bit_pal.cot' )
    ct = ds.GetRasterBand(1).GetRasterColorTable()
    if ct.GetCount() != 256 or ct.GetColorEntry(8) != (8,8,8,255):
        gdaltest.post_reason( 'Wrong color table entry.' )
        return 'fail'

    return 'success'

###############################################################################
# frmt02 is a plain byte format

def ingr_4():

    tst = gdaltest.GDALTest( 'INGR', 'frmt02.cot', 1, 26968 )
    return tst.testOpen()

###############################################################################
# Test creation.

def ingr_5():

    tst = gdaltest.GDALTest( 'INGR', 'frmt02.cot', 1, 26968 )
    return tst.testCreate()

###############################################################################
# Test createcopy.

def ingr_6():

    tst = gdaltest.GDALTest( 'INGR', 'frmt02.cot', 1, 26968 )
    return tst.testCreate()

###############################################################################
# JPEG 8bit

def ingr_7():

    tst = gdaltest.GDALTest( 'INGR', 'frmt30.cot', 1, 29718 )
    return tst.testOpen()

###############################################################################
# Read simple RLE

def ingr_8():

    tst = gdaltest.GDALTest( 'INGR', 'frmt09.cot', 1, 23035 )
    return tst.testOpen()

###############################################################################
# Read Simple RLE Variable

def ingr_9():

    tst = gdaltest.GDALTest( 'INGR', 'frmt10.cot', 1, 47031 )
    return tst.testOpen()

###############################################################################
# CCITT bitonal

def ingr_10():

    tst = gdaltest.GDALTest( 'INGR', 'frmt24.cit', 1, 23035 )
    return tst.testOpen()

###############################################################################
# Adaptive RLE - 24 bit.

def ingr_11():

    tst = gdaltest.GDALTest( 'INGR', 'frmt27.cot', 2, 45616 )
    return tst.testOpen()

###############################################################################
# Uncompressed RGB

def ingr_12():

    tst = gdaltest.GDALTest( 'INGR', 'frmt28.cot', 2, 45616 )
    return tst.testOpen()

###############################################################################
# Adaptive RLE 8bit.

def ingr_13():

    tst = gdaltest.GDALTest( 'INGR', 'frmt29.cot', 1, 26968 )
    return tst.testOpen()

###############################################################################
# JPEG RGB

def ingr_14():

    ds = gdal.Open('data/frmt31.cot')
    cs = ds.GetRasterBand(1).Checksum()
    ds = None

    if cs != 11466 and cs != 11095:
        print(cs)
        return 'fail'

    return 'success'

###############################################################################
# Same, but through vsimem all in memory.

def ingr_15():

    tst = gdaltest.GDALTest( 'INGR', 'frmt02.cot', 1, 26968 )
    result = tst.testCreateCopy( vsimem = 1 )

    try:
        os.remove( 'data/frmt02.cot.aux.xml' )
    except:
        pass

    return result

###############################################################################
# Read simple RLE tiled

def ingr_16():

    tst = gdaltest.GDALTest( 'INGR', 'frmt09t.cot', 1, 3178 )
    return tst.testOpen()

###############################################################################
# Test writing 9 RLE bitonal compression (#5030)

def ingr_17():

    src_ds = gdal.Open('data/frmt09.cot')
    out_ds = gdal.GetDriverByName('INGR').CreateCopy('/vsimem/ingr_17.rle', src_ds)
    del out_ds
    ref_cs = src_ds.GetRasterBand(1).Checksum()
    src_ds = None

    ds = gdal.Open('/vsimem/ingr_17.rle')
    got_cs = ds.GetRasterBand(1).Checksum()
    ds = None

    gdal.GetDriverByName('INGR').Delete('/vsimem/ingr_17.rle')

    if got_cs != ref_cs:
        gdaltest.post_reason('fail')
        print(got_cs)
        print(ref_cs)
        return 'fail'

    return 'success'

###############################################################################
# Test 'random access' in simple RLE

def ingr_18():

    ds = gdal.Open('data/frmt09.cot')
    for y in range(ds.RasterYSize):
        expected_data = ds.ReadRaster(0, y, ds.RasterXSize, 1)
    ds = None

    ds = gdal.Open('data/frmt09.cot')

    ds.ReadRaster(0, 5, ds.RasterXSize, 1)

    got_data = ds.ReadRaster(0, ds.RasterYSize - 1, ds.RasterXSize, 1)

    if got_data != expected_data:
        gdaltest.post_reason('fail')
        return 'fail'

    ds.FlushCache()

    got_data = ds.ReadRaster(0, ds.RasterYSize - 1, ds.RasterXSize, 1)

    if got_data != expected_data:
        gdaltest.post_reason('fail')
        return 'fail'

    return 'success'

gdaltest_list = [
    ingr_1,
    ingr_2,
    ingr_3,
    ingr_4,
    ingr_5,
    ingr_6,
    ingr_7,
    ingr_8,
    ingr_9,
    ingr_10,
    ingr_11,
    ingr_12,
    ingr_13,
    ingr_14,
    ingr_15,
    ingr_16,
    ingr_17,
    ingr_18 ]

if __name__ == '__main__':

    gdaltest.setup_run( 'ingr' )

    gdaltest.run_tests( gdaltest_list )

    gdaltest.summarize()

