scm-file.hpp

// Copyright (C) 2011-2012 Robert Kooima
//
// LIBSCM 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 2 of the License, or (at your option) any later
// version.
//
// This program is distributed in the hope that it will be useful, but WITH-
// OUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
// FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
// more details.

#ifndef SCM_FILE_HPP
#define SCM_FILE_HPP

#include <string>
#include <vector>

#include <tiffio.h>
#include <SDL.h>
#include <SDL_thread.h>

#include "scm-queue.hpp"
#include "scm-guard.hpp"
#include "scm-task.hpp"
#include "scm-sample.hpp"

//------------------------------------------------------------------------------

typedef std::vector<SDL_Thread *>           thread_v;
typedef std::vector<SDL_Thread *>::iterator thread_i;

//------------------------------------------------------------------------------

/// An scm_file encapsulates an open SCM data file.

class scm_file
{
public:

    scm_file(const std::string&,
             const std::string&);

    virtual ~scm_file();

    void    activate(scm_cache *);
    void  deactivate();
    bool is_active() const;

    bool           add_need(scm_task&);

    virtual bool   get_page_status(uint64)                 const;
    virtual uint64 get_page_offset(uint64)                 const;
    virtual void   get_page_bounds(uint64, float&, float&) const;
    virtual float  get_page_sample(const double *);

    virtual uint32 get_w()    const { return w; }
    virtual uint32 get_h()    const { return h; }
    virtual uint16 get_c()    const { return c; }
    virtual uint16 get_b()    const { return b; }

    const char    *get_path() const { return path.c_str(); }
    const char    *get_name() const { return name.c_str(); }

    uint64        find_page(long long, double&, double&) const;

protected:

    std::string path;
    std::string name;

private:

    // IO handling and threading data

    scm_cache          *cache;
    scm_queue<scm_task> needs;
    scm_guard<bool>     active;
    scm_sample         *sampler;
    thread_v            threads;

    // Image parameters

    uint32   w;         ///< Page width
    uint32   h;         ///< Page height
    uint16   c;         ///< Sample count
    uint16   b;         ///< Sample depth

    uint64 *xv;         ///< Page indices
    uint64  xc;         ///< Page indices count

    uint64 *ov;         ///< Page offsets
    uint64  oc;         ///< Page offsets count

    void   *av;         ///< Page minima
    uint64  ac;         ///< Page minima count

    void   *zv;         ///< Page maxima
    uint64  zc;         ///< Page maxima count

    float  tofloat(const void *, uint64)        const;
    void fromfloat(const void *, uint64, float) const;

    uint64 toindex(uint64) const;

    friend int loader(void *);
};

//------------------------------------------------------------------------------
/// @file

bool scm_load_page(const char *, long long,
                         TIFF *, uint64, int, int, int, int, void *);

//------------------------------------------------------------------------------

#endif