#!/usr/bin/env python
###############################################################################
# $Id$
#
# Project:  GDAL/OGR Test Suite
# Purpose:  Test read/write functionality for GIF driver.
# Author:   Frank Warmerdam <warmerdam@pobox.com>
# 
###############################################################################
# Copyright (c) 2004, Frank Warmerdam <warmerdam@pobox.com>
# 
# 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
import gdal

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

import gdaltest

###############################################################################
# Get the GIF driver, and verify a few things about it. 

def gif_1():

    gdaltest.gif_drv = gdal.GetDriverByName( 'GIF' )
    if gdaltest.gif_drv is None:
        gdaltest.post_reason( 'GIF driver not found!' )
        return 'false'
    
    # Move the BIGGIF driver after the GIF driver.
    drv = gdal.GetDriverByName( 'BIGGIF' )
    drv.Deregister();
    drv.Register()
    
    drv_md = gdaltest.gif_drv.GetMetadata()
    if drv_md['DMD_MIMETYPE'] != 'image/gif':
        gdaltest.post_reason( 'mime type is wrong' )
        return 'false'

    return 'success'

###############################################################################
# Read test of simple byte reference data.

def gif_2():

    tst = gdaltest.GDALTest( 'GIF', 'bug407.gif', 1, 57921 )
    return tst.testOpen()

###############################################################################
# Test lossless copying.

def gif_3():

    tst = gdaltest.GDALTest( 'GIF', 'bug407.gif', 1, 57921,
                             options = [ 'INTERLACING=NO' ] )

    return tst.testCreateCopy()
    
###############################################################################
# Verify the colormap, and nodata setting for test file. 

def gif_4():

    ds = gdal.Open( 'data/bug407.gif' )
    cm = ds.GetRasterBand(1).GetRasterColorTable()
    if cm.GetCount() != 16 \
       or cm.GetColorEntry(0) != (255,255,255,255) \
       or cm.GetColorEntry(1) != (255,255,208,255):
        gdaltest.post_reason( 'Wrong colormap entries' )
        return 'fail'

    cm = None

    if ds.GetRasterBand(1).GetNoDataValue() is not None:
        gdaltest.post_reason( 'Wrong nodata value.' )
        return 'fail'

    md = ds.GetRasterBand(1).GetMetadata()
    if 'GIF_BACKGROUND' not in md or md['GIF_BACKGROUND'] != '0':
        print(md)
        gdaltest.post_reason( 'background metadata missing.' )
        return 'fail'

    return 'success'
    
###############################################################################
# Test creating an in memory copy.

def gif_5():

    tst = gdaltest.GDALTest( 'GIF', 'byte.tif', 1, 4672 )

    return tst.testCreateCopy( vsimem = 1 )

###############################################################################
# Verify nodata support

def gif_6():

    src_ds = gdal.Open( '../gcore/data/nodata_byte.tif' )

    new_ds = gdaltest.gif_drv.CreateCopy( 'tmp/nodata_byte.gif', src_ds )
    if new_ds is None:
        gdaltest.post_reason( 'Create copy operation failure' )
        return 'false'

    bnd = new_ds.GetRasterBand(1)
    if bnd.Checksum() != 4440:
        gdaltest.post_reason( 'Wrong checksum' )
        return 'false'

    bnd = None
    new_ds = None
    src_ds = None

    new_ds = gdal.Open( 'tmp/nodata_byte.gif' )
    
    bnd = new_ds.GetRasterBand(1)
    if bnd.Checksum() != 4440:
        gdaltest.post_reason( 'Wrong checksum' )
        return 'false'

    # NOTE - mloskot: condition may fauil as nodata is a float-point number
    nodata = bnd.GetNoDataValue()
    if nodata != 0:
        gdaltest.post_reason( 'Got unexpected nodata value.' )
        return 'false'

    bnd = None
    new_ds = None

    gdaltest.gif_drv.Delete( 'tmp/nodata_byte.gif' )

    return 'success'


###############################################################################
# Confirm reading with the BIGGIF driver.

def gif_7():

    # Move the GIF driver after the BIGGIF driver.
    drv = gdal.GetDriverByName( 'GIF' )
    drv.Deregister();
    drv.Register()

    tst = gdaltest.GDALTest( 'BIGGIF', 'bug407.gif', 1, 57921 )

    if tst.testOpen() != 'success':
        return 'fail'

    ds = gdal.Open('data/bug407.gif')
    if ds is None:
        return 'fail'

    if ds.GetDriver().ShortName != 'BIGGIF':
        return 'fail'

    return 'success'

###############################################################################
# Confirm that BIGGIF driver is selected for huge gifs

def gif_8():

    # Move the BIGGIF driver after the GIF driver.
    drv = gdal.GetDriverByName( 'BIGGIF' )
    drv.Deregister();
    drv.Register()

    ds = gdal.Open('data/fakebig.gif')
    if ds is None:
        return 'fail'

    if ds.GetDriver().ShortName != 'BIGGIF':
        return 'fail'

    return 'success'

###############################################################################
# Cleanup.

def gif_cleanup():
    gdaltest.clean_tmp()
    return 'success'

gdaltest_list = [
    gif_1,
    gif_2,
    gif_3,
    gif_4,
    gif_5,
    gif_6,
    gif_7,
    gif_8,
    gif_cleanup ]

if __name__ == '__main__':

    gdaltest.setup_run( 'gif' )

    gdaltest.run_tests( gdaltest_list )

    gdaltest.summarize()