imagealbum-dialog.h

/* ScummVM - Graphic Adventure Engine
 *
 * ScummVM is the legal property of its developers, whose names
 * are too numerous to list here. Please refer to the COPYRIGHT
 * file distributed with this source distribution.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 */

#ifndef IMAGEALBUM_DIALOG_H
#define IMAGEALBUM_DIALOG_H

#include "common/formats/formatinfo.h"
#include "common/str.h"
#include "common/rational.h"

namespace Common {

class SeekableReadStream;

} // End of namespace Common

namespace Graphics {

class Palette;
struct Surface;

} // End of namespace Graphics

namespace GUI {

class Dialog;

enum ImageAlbumImageOrientation {
    kImageAlbumImageOrientationUnspecified,

    kImageAlbumImageOrientationLandscape,
    kImageAlbumImageOrientationPortrait,
};

enum ImageAlbumViewTransformation {
    kImageAlbumViewTransformationNone,
    kImageAlbumViewTransformationRotate90CCW,
    kImageAlbumViewTransformationRotate90CW,
    kImageAlbumViewTransformationRotate180,
};

struct ImageAlbumImageMetadata {
    ImageAlbumImageMetadata() : _orientation(kImageAlbumImageOrientationUnspecified), _viewTransformation(kImageAlbumViewTransformationNone), _hdpi(72, 1), _vdpi(72, 1) {}

    ImageAlbumViewTransformation _viewTransformation;   
    ImageAlbumImageOrientation _orientation;            
    Common::Rational _hdpi;                             
    Common::Rational _vdpi;                             
};

class ImageAlbumImageSupplier {
public:
    virtual ~ImageAlbumImageSupplier();

    virtual bool loadImageSlot(uint slot, const Graphics::Surface *&outSurface, bool &outHasPalette, Graphics::Palette &outPalette, ImageAlbumImageMetadata &outMetadata) = 0;

    virtual void releaseImageSlot(uint slot) = 0;

    virtual bool getFileFormatForImageSlot(uint slot, Common::FormatInfo::FormatID &outFormat) const = 0;

    virtual Common::SeekableReadStream *createReadStreamForSlot(uint slot) = 0;

    virtual uint getNumSlots() const = 0;

    virtual Common::U32String getDefaultFileNameForSlot(uint slot) const = 0;
};

Dialog *createImageAlbumDialog(const Common::U32String &title, ImageAlbumImageSupplier *imageSupplier, uint initialSlot);

} // End of namespace GUI

#endif