-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | A streamable, seekable, zoomable cache file format
--   
--   zoom-cache is a fairly simple data file format for storing and
--   summarizing streams of time-series data. The purpose of this format is
--   to make it easy to quickly generate plots; <i>zooming</i> refers to
--   being able to render a window of data, and being able to quickly
--   change the bounds of the window: to move around and to zoom in and
--   out.
--   
--   This library provides a monadic writing and an iteratee reading
--   interface for zoom-cache files.
--   
--   What's neat about this format and library? Glad you asked!
--   
--   <ul>
--   <li>Data can be stored at variable or constant rates. For variable
--   rate data, a timestamp is explicitly written into the file for every
--   value, which is useful for recording events that occur at
--   unpredictable times. Constant rate is useful for regularly sampled
--   data, like most digital audio and video recordings.</li>
--   <li>While writing a file, summary blocks (such as minimum, maximum,
--   mean and RMS values) are written out every n samples. The summary
--   blocks are hierarchical, such that after two have been written, a new
--   one containing a merged summary of those is written. After two of
--   those Level 1 summary blocks have been written, a new Level 2 summary
--   block combining those is written, and so on.</li>
--   <li>You can write your own zoom-cache codecs for custom data types, or
--   to implement custom summary functions. In order to do so you provide a
--   <a>Summary</a> data type, functions for encoding and decoding raw data
--   values and summaries, and a function for merging <a>Summary</a>
--   blocks. For details, see <a>Data.ZoomCache.Codec</a>.</li>
--   <li>Writing of raw data blocks is optional, under control of the
--   application. If you already have the raw data stored in an easily
--   accessible format, your zoom-cache files may just contain the summary
--   data. On the other hand, if your input data is the result of expensive
--   calculations you may want to store it along with the summary data so
--   that plots of any level of detail can be rendered from a single
--   file.</li>
--   </ul>
--   
--   When developing applications that read or write zoom-cache files, it
--   should be sufficient to import only the module <a>Data.ZoomCache</a>.
@package zoom-cache
@version 0.5.0.0


-- | The minimum and maximum positive, finite floats.
module Data.ZoomCache.Numeric.FloatMinMax

-- | The minimum positive, denormalized float.
floatMin :: RealFloat a => a

-- | The maximum denormalized float.
floatMaxDenorm :: RealFloat a => a

-- | The minimum positive, normalized float.
floatMinNorm :: RealFloat a => a

-- | The maximum finite float.
floatMax :: RealFloat a => a


-- | zoom-cache format specification
--   
--   Field encoding formats:
--   
--   <tt>int16</tt>: 16bit big endian
--   
--   <tt>int32</tt>: 32bit big endian
--   
--   <tt>double</tt>: big-endian IEEE 754-2008 binary64 (IEEE 754-1985
--   double)
module Data.ZoomCache.Format

-- | Global header:
--   
--   <pre>
--    0                   1                   2                   3
--    0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1| Byte
--   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--   | Identifier                                                    | 0-3
--   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--   | ...                                                           | 4-7
--   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--   | Version major (int16)         | Version minor (int16)         | 8-11
--   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--   | No. tracks (int32)                                            | 12-15
--   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--   | Presentationtime numerator (int64)                            | 16-19
--   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--   | ...                                                           | 20-23
--   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--   | Presentationtime denominator (int64)                          | 24-27
--   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--   | ...                                                           | 28-31
--   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--   | Basetime numerator (int64)                                    | 32-35
--   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--   | ...                                                           | 36-39
--   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--   | Basetime denominator (int64)                                  | 40-43
--   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--   | ...                                                           | 44-47
--   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--   | UTC                                                           | 48-51
--   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--   | ...                                                           | 52-55
--   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--   | ...                                                           | 56-59
--   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--   | ...                                                           | 60-63
--   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--   | ...                                                           | 64-67
--   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--   </pre>
globalHeader :: ByteString

-- | The major version encoded by this library
versionMajor :: Int

-- | The minor version encoded by this library
versionMinor :: Int

-- | Track header:
--   
--   <pre>
--    0                   1                   2                   3
--    0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1| Byte
--   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--   | Identifier                                                    | 0-3
--   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--   | ...                                                           | 4-7
--   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--   | Track no. (int32)                                             | 8-11
--   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--   | Codec identifier                                              | 12-15
--   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--   | ...                                                           | 16-19
--   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--   | Flag: 0=CBR, 1=VBR                                            | 20-23
--   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--   | Datarate numerator (int64)                                    | 24-27
--   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--   | ...                                                           | 28-31
--   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--   | Datarate denominator (int64)                                  | 32-35
--   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--   | ...                                                           | 36-39
--   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--   | Length of name in bytes (int32)                               | 40-43
--   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--   | Name (UTF-8) ...                                              | 44-
--   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--   </pre>
--   
--   Datarate: numerator 0 indicates variable bitrate (all data values are
--   timestamped)
trackHeader :: ByteString

-- | Raw Data Packet header:
--   
--   <pre>
--    0                   1                   2                   3
--    0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1| Byte
--   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--   | Identifier                                                    | 0-3
--   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--   | ...                                                           | 4-7
--   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--   | Track no. (int32)                                             | 8-11
--   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--   | Entry Timestamp (int64)                                       | 12-15
--   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--   | ...                                                           | 16-19
--   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--   | Exit TImestamp (int64)                                        | 20-23
--   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--   | ...                                                           | 24-27
--   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--   | Count of data points COUNT (int32)                            | 28-31
--   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--   | Payload length in bytes (remainder of packet) (int32)         | 32-35
--   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--   | Data ...                                                      | 36-39
--   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--   | ...                                                           | 40-
--   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--   | Timestamps ...                                                | TS-
--   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--   | ...                                                           |
--   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--   </pre>
--   
--   Timestamps block is only present if VBR (datarate numerator is 0)
--   
--   TS = 28 + (COUNT * sizeof(Type))
packetHeader :: ByteString

-- | Summary Data Packet header:
--   
--   <pre>
--    0                   1                   2                   3
--    0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1| Byte
--   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--   | Identifier                                                    | 0-3
--   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--   | ...                                                           | 4-7
--   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--   | Track no. (int32)                                             | 8-11
--   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--   | Level (int32)                                                 | 12-15
--   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--   | Entry Timestamp (int64)                                       | 16-19
--   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--   | ...                                                           | 20-23
--   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--   | Exit Timestamp (int64)                                        | 24-27
--   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--   | ...                                                           | 28-31
--   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--   | Summary length in bytes (int32)                               | 32-35
--   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--   | Summary Data ...                                              | 36-
--   </pre>
--   
--   Some default encodings of Summary Data are provided in modules
--   <a>Data.ZoomCache.Double</a> and <a>Data.ZoomCache.Int</a>.
summaryHeader :: ByteString


-- | Iteratee reading of ZoomCache files.
module Data.Iteratee.ZoomCache.Utils

-- | Read 1 byte as an Integral
readInt8 :: (Nullable s, ListLike s Word8, Functor m, MonadIO m, Integral a) => Iteratee s m a

-- | Read 2 bytes as a big-endian Integral
readInt16be :: (Nullable s, ListLike s Word8, Functor m, MonadIO m, Integral a) => Iteratee s m a

-- | Read 4 bytes as a big-endian Integral
readInt32be :: (Nullable s, ListLike s Word8, Functor m, MonadIO m, Integral a) => Iteratee s m a

-- | Read 8 bytes as a big-endian Integral
readInt64be :: (Nullable s, ListLike s Word8, Functor m, MonadIO m, Integral a) => Iteratee s m a

-- | Read 4 bytes as a big-endian Float
readFloat32be :: (Nullable s, ListLike s Word8, Functor m, MonadIO m) => Iteratee s m Float

-- | Read 8 bytes as a big-endian Double
readDouble64be :: (Nullable s, ListLike s Word8, Functor m, MonadIO m) => Iteratee s m Double

-- | Read 16 bytes as a big-endian Rational, encoded as an 8 byte big
--   endian numerator followed by an 8 byte big endian denominator.
readRational64be :: (Nullable s, ListLike s Word8, Functor m, MonadIO m) => Iteratee s m Rational


-- | Types used throughout zoom-cache
module Data.ZoomCache.Common
data TimeStamp
TS :: {-# UNPACK #-} !Int64 -> TimeStamp
unTS :: TimeStamp -> {-# UNPACK #-} !Int64
data TimeStampDiff
TSDiff :: {-# UNPACK #-} !Int64 -> TimeStampDiff
unTSDiff :: TimeStampDiff -> {-# UNPACK #-} !Int64

-- | <pre>
--   timeStampDiff (TS t1) (TS t2) = TSDiff (t1 - t2)
--   </pre>
timeStampDiff :: TimeStamp -> TimeStamp -> TimeStampDiff

-- | Constant or Variable datarate. For constant datarate, timestamps are
--   implied as incrementing by 1/datarate For variable datarate, explicit
--   timestamps are attached to each datum, encoded as a separate block of
--   timestamps in the Raw Data packet.
data DataRateType
ConstantDR :: DataRateType
VariableDR :: DataRateType
type TrackNo = Int
data Global
Global :: Version -> Int -> Rational -> Rational -> Maybe Int -> Global
version :: Global -> Version
noTracks :: Global -> Int
presentationTime :: Global -> Rational
baseTime :: Global -> Rational
baseUTC :: Global -> Maybe Int
data Version
Version :: !Int -> !Int -> Version
instance Eq TimeStamp
instance Ord TimeStamp
instance Show TimeStamp
instance Eq TimeStampDiff
instance Ord TimeStampDiff
instance Show TimeStampDiff
instance Eq Version
instance Show Version
instance Show Global
instance Show DataRateType


-- | ZoomCache packet and summary types and interfaces
module Data.ZoomCache.Types
data Codec
Codec :: a -> Codec

-- | A map of all track numbers to their <a>TrackSpec</a>
type TrackMap = IntMap TrackSpec

-- | A specification of the type and name of each track
data TrackSpec
TrackSpec :: !Codec -> !DataRateType -> {-# UNPACK #-} !Rational -> !ByteString -> TrackSpec
specType :: TrackSpec -> !Codec
specDRType :: TrackSpec -> !DataRateType
specRate :: TrackSpec -> {-# UNPACK #-} !Rational
specName :: TrackSpec -> !ByteString

-- | Identify the tracktype corresponding to a given Codec Identifier. When
--   parsing a zoom-cache file, the zoom-cache library will try each of a
--   given list [<tt>IdentifyTrack</tt>].
--   
--   The standard zoom-cache instances are provided in
--   <tt>standardIdentifiers</tt>.
--   
--   When developing your own codecs it is not necessary to build a
--   composite <tt>IdentifyTrack</tt> functions; it is sufficient to
--   generate one for each new codec type. A library of related zoom-cache
--   codecs should export its own [<tt>IdentifyTrack</tt>] functions,
--   usually called something like mylibIdentifiers.
--   
--   These can be generated with <tt>identifyCodec</tt>.
type IdentifyCodec = ByteString -> Maybe Codec

-- | A codec instance must specify a <a>SummaryData</a> type, and implement
--   all methods of this class.
class Typeable a => ZoomReadable a where { data family SummaryData a :: *; }
trackIdentifier :: ZoomReadable a => a -> ByteString
readRaw :: (ZoomReadable a, Nullable s, ListLike s Word8, Functor m, MonadIO m) => Iteratee s m a
readSummary :: (ZoomReadable a, Nullable s, ListLike s Word8, Functor m, MonadIO m) => Iteratee s m (SummaryData a)
prettyRaw :: ZoomReadable a => a -> String
prettySummaryData :: ZoomReadable a => SummaryData a -> String

-- | A codec instance must additionally specify a <a>SummaryWork</a> type
class ZoomReadable a => ZoomWritable a where { data family SummaryWork a :: *; }
fromRaw :: ZoomWritable a => a -> Builder
fromSummaryData :: ZoomWritable a => SummaryData a -> Builder
initSummaryWork :: ZoomWritable a => TimeStamp -> SummaryWork a
updateSummaryData :: ZoomWritable a => TimeStamp -> a -> SummaryWork a -> SummaryWork a
toSummaryData :: ZoomWritable a => TimeStampDiff -> SummaryWork a -> SummaryData a
appendSummaryData :: ZoomWritable a => TimeStampDiff -> SummaryData a -> TimeStampDiff -> SummaryData a -> SummaryData a
data ZoomRaw
ZoomRaw :: [a] -> ZoomRaw
data ZoomSummary
ZoomSummary :: (Summary a) -> ZoomSummary
data ZoomWork
ZoomWork :: IntMap (Summary a -> Summary a) -> Maybe (SummaryWork a) -> ZoomWork
levels :: ZoomWork -> IntMap (Summary a -> Summary a)
currWork :: ZoomWork -> Maybe (SummaryWork a)
data Packet
Packet :: {-# UNPACK #-} !TrackNo -> {-# UNPACK #-} !TimeStamp -> {-# UNPACK #-} !TimeStamp -> {-# UNPACK #-} !Int -> !ZoomRaw -> ![TimeStamp] -> Packet
packetTrack :: Packet -> {-# UNPACK #-} !TrackNo
packetEntryTime :: Packet -> {-# UNPACK #-} !TimeStamp
packetExitTime :: Packet -> {-# UNPACK #-} !TimeStamp
packetCount :: Packet -> {-# UNPACK #-} !Int
packetData :: Packet -> !ZoomRaw
packetTimeStamps :: Packet -> ![TimeStamp]

-- | A recorded block of summary data
data Summary a
Summary :: {-# UNPACK #-} !TrackNo -> {-# UNPACK #-} !Int -> {-# UNPACK #-} !TimeStamp -> {-# UNPACK #-} !TimeStamp -> !SummaryData a -> Summary a
summaryTrack :: Summary a -> {-# UNPACK #-} !TrackNo
summaryLevel :: Summary a -> {-# UNPACK #-} !Int
summaryEntryTime :: Summary a -> {-# UNPACK #-} !TimeStamp
summaryExitTime :: Summary a -> {-# UNPACK #-} !TimeStamp
summaryData :: Summary a -> !SummaryData a

-- | The duration covered by a summary, in units of 1 / the track's
--   datarate
summaryDuration :: Summary a -> TimeStampDiff

-- | Global and track headers for a zoom-cache file
data CacheFile
CacheFile :: Global -> IntMap TrackSpec -> CacheFile
cfGlobal :: CacheFile -> Global
cfSpecs :: CacheFile -> IntMap TrackSpec

-- | Create an empty <a>CacheFile</a> using the given <a>Global</a>
mkCacheFile :: Global -> CacheFile

-- | Determine whether all tracks of a <a>CacheFile</a> are specified
fiFull :: CacheFile -> Bool
instance Show TrackSpec
instance Show Codec


-- | Iteratee reading of ZoomCache files.
module Data.Iteratee.ZoomCache
data Stream
StreamPacket :: CacheFile -> TrackNo -> Packet -> Stream
strmFile :: Stream -> CacheFile
strmTrack :: Stream -> TrackNo
strmPacket :: Stream -> Packet
StreamSummary :: CacheFile -> TrackNo -> ZoomSummary -> Stream
strmFile :: Stream -> CacheFile
strmTrack :: Stream -> TrackNo
strmSummary :: Stream -> ZoomSummary
StreamNull :: Stream

-- | Parse only the global and track headers of a zoom-cache file,
--   returning a <a>CacheFile</a>
iterHeaders :: (Nullable s, ListLike s Word8, Functor m, MonadIO m) => [IdentifyCodec] -> Iteratee s m CacheFile

-- | An enumeratee of a zoom-cache file, from the global header onwards.
--   The global and track headers will be transparently read, and the
--   <a>CacheFile</a> visible in the <a>Stream</a> elements.
enumCacheFile :: (Nullable s, ListLike s Word8, Functor m, MonadIO m) => [IdentifyCodec] -> Enumeratee s Stream m a

-- | An enumeratee of zoom-cache data, after global and track headers have
--   been read, or if the <a>CacheFile</a> has been acquired elsewhere.
enumStream :: (Nullable s, ListLike s Word8, Functor m, MonadIO m) => CacheFile -> Enumeratee s Stream m a

-- | Map a monadic <a>Stream</a> processing function over an entire
--   zoom-cache file.
mapStream :: (Nullable s, ListLike s Word8, Functor m, MonadIO m) => [IdentifyCodec] -> (Stream -> m ()) -> Iteratee s m ()

-- | Map a monadic <a>Packet</a> processing function over an entire
--   zoom-cache file.
mapPackets :: (Nullable s, ListLike s Word8, Functor m, MonadIO m) => [IdentifyCodec] -> (Packet -> m ()) -> Iteratee s m ()

-- | Map a monadic <a>Summary</a> processing function over an entire
--   zoom-cache file.
mapSummaries :: (Nullable s, ListLike s Word8, Functor m, MonadIO m) => [IdentifyCodec] -> (ZoomSummary -> m ()) -> Iteratee s m ()
instance NullPoint Stream
instance Nullable Stream


-- | Identifiers for track types of ZoomCache files.
module Data.ZoomCache.Identify

-- | Generate an <tt>IdentifyTrack</tt> function for a given type.
identifyCodec :: ZoomReadable a => a -> IdentifyCodec


-- | Pretty-printing of zoom-cache types
module Data.ZoomCache.Pretty

-- | Pretty-print a <a>Global</a>
prettyGlobal :: Global -> String

-- | Pretty-print a <a>TrackSpec</a>
prettyTrackSpec :: TrackNo -> TrackSpec -> String

-- | Pretty-print a <a>TimeStamp</a>, given a datarate
prettyTimeStamp :: Rational -> TimeStamp -> String

-- | Pretty-print a <a>Summary</a>, given a datarate
prettySummary :: ZoomReadable a => Rational -> Summary a -> String


-- | Blaze-builder utility functions for writing ZoomCache files.
module Blaze.ByteString.Builder.ZoomCache

-- | Serialize a <a>TimeStamp</a> in 64bit big endian format.
fromTimeStamp :: TimeStamp -> Builder

-- | Serialize a <a>Float</a> in big-endian IEEE 754-2008 binary32 format
--   (IEEE 754-1985 single format).
fromFloat :: Float -> Builder

-- | Serialize a <a>Double</a> in big-endian IEEE 754-2008 binary64 format
--   (IEEE 754-1985 double format).
fromDouble :: Double -> Builder

-- | Serialize an <a>Integral</a> in 32bit big endian format.
fromIntegral32be :: Integral a => a -> Builder

-- | Serialize a <a>Rational</a> as a sequence of two 64bit big endian
--   format integers.
fromRational64 :: Rational -> Builder


-- | Writing of ZoomCache files.
module Data.ZoomCache.Write

-- | The ZoomWrite class provides <a>write</a>, a method to write a Haskell
--   value to an open ZoomCache file.
class ZoomWrite t
write :: ZoomWrite t => TrackNo -> t -> ZoomW ()
writeData :: (Typeable a, ZoomWrite a, ZoomWritable a) => TrackNo -> a -> ZoomW ()
writeDataVBR :: (Typeable a, ZoomWrite a, ZoomWritable a) => TrackNo -> (TimeStamp, a) -> ZoomW ()

-- | A StateT IO monad for writing a ZoomCache file
type ZoomW = StateT ZoomWHandle IO

-- | Run a <tt>ZoomW ()</tt> action on a given file handle, using the
--   specified <a>TrackMap</a> specification
withFileWrite :: TrackMap -> Bool -> ZoomW () -> FilePath -> IO ()

-- | Force a flush of ZoomCache summary blocks to disk. It is not usually
--   necessary to call this function as summary blocks are transparently
--   written at regular intervals.
flush :: ZoomW ()
data ZoomWHandle

-- | Open a new ZoomCache file for writing, using a specified
--   <a>TrackMap</a>.
openWrite :: TrackMap -> Bool -> FilePath -> IO ZoomWHandle
closeWrite :: ZoomWHandle -> IO ()

-- | Query the maximum number of data points to buffer for a given track
--   before forcing a flush of all buffered data and summaries.
watermark :: TrackNo -> ZoomW (Maybe Int)

-- | Set the maximum number of data points to buffer for a given track
--   before forcing a flush of all buffered data and summaries.
setWatermark :: TrackNo -> Int -> ZoomW ()

-- | Create a track map for a stream of a given type, as track no. 1
oneTrack :: ZoomReadable a => a -> DataRateType -> Rational -> ByteString -> TrackMap


-- | This module re-exports the required interfaces and some useful
--   functions for developing zoom-cache codecs.
--   
--   To implement a codec, specify <a>SummaryData</a> and
--   <a>SummaryWork</a> types, and implement the methods of the
--   ZoomReadable and ZoomWritable classes.
--   
--   For sample implementations, read the source of the provided instances
--   <a>Data.ZoomCache.Int</a> and <a>Data.ZoomCache.Double</a>.
module Data.ZoomCache.Codec

-- | A codec instance must specify a <a>SummaryData</a> type, and implement
--   all methods of this class.
class Typeable a => ZoomReadable a where { data family SummaryData a :: *; }
trackIdentifier :: ZoomReadable a => a -> ByteString
readRaw :: (ZoomReadable a, Nullable s, ListLike s Word8, Functor m, MonadIO m) => Iteratee s m a
readSummary :: (ZoomReadable a, Nullable s, ListLike s Word8, Functor m, MonadIO m) => Iteratee s m (SummaryData a)
prettyRaw :: ZoomReadable a => a -> String
prettySummaryData :: ZoomReadable a => SummaryData a -> String

-- | A codec instance must additionally specify a <a>SummaryWork</a> type
class ZoomReadable a => ZoomWritable a where { data family SummaryWork a :: *; }
fromRaw :: ZoomWritable a => a -> Builder
fromSummaryData :: ZoomWritable a => SummaryData a -> Builder
initSummaryWork :: ZoomWritable a => TimeStamp -> SummaryWork a
updateSummaryData :: ZoomWritable a => TimeStamp -> a -> SummaryWork a -> SummaryWork a
toSummaryData :: ZoomWritable a => TimeStampDiff -> SummaryWork a -> SummaryData a
appendSummaryData :: ZoomWritable a => TimeStampDiff -> SummaryData a -> TimeStampDiff -> SummaryData a -> SummaryData a

-- | The ZoomWrite class provides <a>write</a>, a method to write a Haskell
--   value to an open ZoomCache file.
class ZoomWrite t
write :: ZoomWrite t => TrackNo -> t -> ZoomW ()

-- | Generate an <tt>IdentifyTrack</tt> function for a given type.
identifyCodec :: ZoomReadable a => a -> IdentifyCodec

-- | Read 1 byte as an Integral
readInt8 :: (Nullable s, ListLike s Word8, Functor m, MonadIO m, Integral a) => Iteratee s m a

-- | Read 2 bytes as a big-endian Integral
readInt16be :: (Nullable s, ListLike s Word8, Functor m, MonadIO m, Integral a) => Iteratee s m a

-- | Read 4 bytes as a big-endian Integral
readInt32be :: (Nullable s, ListLike s Word8, Functor m, MonadIO m, Integral a) => Iteratee s m a

-- | Read 8 bytes as a big-endian Integral
readInt64be :: (Nullable s, ListLike s Word8, Functor m, MonadIO m, Integral a) => Iteratee s m a

-- | Read 4 bytes as a big-endian Float
readFloat32be :: (Nullable s, ListLike s Word8, Functor m, MonadIO m) => Iteratee s m Float

-- | Read 8 bytes as a big-endian Double
readDouble64be :: (Nullable s, ListLike s Word8, Functor m, MonadIO m) => Iteratee s m Double

-- | Read 16 bytes as a big-endian Rational, encoded as an 8 byte big
--   endian numerator followed by an 8 byte big endian denominator.
readRational64be :: (Nullable s, ListLike s Word8, Functor m, MonadIO m) => Iteratee s m Rational
writeData :: (Typeable a, ZoomWrite a, ZoomWritable a) => TrackNo -> a -> ZoomW ()
writeDataVBR :: (Typeable a, ZoomWrite a, ZoomWritable a) => TrackNo -> (TimeStamp, a) -> ZoomW ()

-- | Serialize a <a>Rational</a> as a sequence of two 64bit big endian
--   format integers.
fromRational64 :: Rational -> Builder

-- | Serialize an <a>Integral</a> in 32bit big endian format.
fromIntegral32be :: Integral a => a -> Builder

-- | Serialize a <a>Float</a> in big-endian IEEE 754-2008 binary32 format
--   (IEEE 754-1985 single format).
fromFloat :: Float -> Builder

-- | Serialize a <a>Double</a> in big-endian IEEE 754-2008 binary64 format
--   (IEEE 754-1985 double format).
fromDouble :: Double -> Builder
data Codec
data TimeStamp
TS :: {-# UNPACK #-} !Int64 -> TimeStamp
unTS :: TimeStamp -> {-# UNPACK #-} !Int64
data TimeStampDiff
TSDiff :: {-# UNPACK #-} !Int64 -> TimeStampDiff
unTSDiff :: TimeStampDiff -> {-# UNPACK #-} !Int64

-- | <pre>
--   timeStampDiff (TS t1) (TS t2) = TSDiff (t1 - t2)
--   </pre>
timeStampDiff :: TimeStamp -> TimeStamp -> TimeStampDiff


-- | Default codec implementation for values of type Bool. Elements of type
--   Bool are useful for recording observations of binary events.
--   
--   This module implements the interfaces documented in
--   <a>Data.ZoomCache.Codec</a>.
--   
--   The table below describes the encoding of SummaryData for Bool.
--   
--   <pre>
--   | ...                                                           |   -35
--   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--   | Expected value (double)                                       | 36-39
--   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--   | ...                                                           | 40-43
--   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--   </pre>
--   
--   Field encoding formats:
--   
--   <tt>double</tt>: big-endian IEEE 754-2008 binary64 (IEEE 754-1985
--   double)
module Data.ZoomCache.Bool
instance ZoomWritable Bool
instance ZoomWrite (TimeStamp, Bool)
instance ZoomWrite Bool
instance ZoomReadable Bool


-- | Default codec implementation for values of type (). Elements of type
--   () are useful for marking events, and variable rate tracks written
--   with type (TimeStamp, ()) are useful for recording times of events.
--   
--   This module implements the interfaces documented in
--   <a>Data.ZoomCache.Codec</a>.
--   
--   As elements of type () contain no unique information it is sufficient
--   to record only a count of elements which occur within each packet.
--   
--   No raw data is encoded for tracks of type () as the raw data packet
--   header already includes a count of elements. This is implemented by
--   specifying const <a>mempty</a>) as the <a>Builder</a> and (return ())
--   as the reader.
--   
--   The table below describes the encoding of SummaryData for ().
--   
--   <pre>
--   | ...                                                           |   -35
--   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--   | Count (int32)                                                 | 36-39
--   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--   </pre>
--   
--   Field encoding formats:
--   
--   <tt>int32</tt>: 32bit big endian
module Data.ZoomCache.Unit
instance ZoomWritable ()
instance ZoomWrite (TimeStamp, ())
instance ZoomWrite ()
instance ZoomReadable ()

module Data.ZoomCache.Numeric.Types
class (Ord a, Real a, ZoomReadable a, ZoomWritable a) => ZoomNum a
numEntry :: ZoomNum a => SummaryData a -> a
numExit :: ZoomNum a => SummaryData a -> a
numMin :: ZoomNum a => SummaryData a -> a
numMax :: ZoomNum a => SummaryData a -> a
numAvg :: ZoomNum a => SummaryData a -> Double
numRMS :: ZoomNum a => SummaryData a -> Double
numWorkTime :: ZoomNum a => SummaryWork a -> TimeStamp
numWorkEntry :: ZoomNum a => SummaryWork a -> Maybe a
numWorkExit :: ZoomNum a => SummaryWork a -> a
numWorkMin :: ZoomNum a => SummaryWork a -> a
numWorkMax :: ZoomNum a => SummaryWork a -> a
numWorkSum :: ZoomNum a => SummaryWork a -> Double
numWorkSumSq :: ZoomNum a => SummaryWork a -> Double
numMkSummary :: ZoomNum a => a -> a -> a -> a -> Double -> Double -> SummaryData a
numMkSummaryWork :: ZoomNum a => TimeStamp -> Maybe a -> a -> a -> a -> Double -> Double -> SummaryWork a

module Data.ZoomCache.Numeric.Internal
readSummaryNum :: (Nullable s, ListLike s Word8, Functor m, MonadIO m, ZoomNum a) => Iteratee s m (SummaryData a)
fromSummaryNum :: ZoomNum a => SummaryData a -> Builder
initSummaryNumBounded :: (Bounded a, ZoomNum a) => TimeStamp -> SummaryWork a
mkSummaryNum :: ZoomNum a => TimeStampDiff -> SummaryWork a -> SummaryData a
appendSummaryNum :: ZoomNum a => TimeStampDiff -> SummaryData a -> TimeStampDiff -> SummaryData a -> SummaryData a
updateSummaryNum :: ZoomNum a => TimeStamp -> a -> SummaryWork a -> SummaryWork a


-- | Default codec implementation for values of type Float and Double. This
--   module implements the interfaces documented in
--   <a>Data.ZoomCache.Codec</a>. View the module source for enlightenment.
--   
--   The table below describes the encoding of SummaryData for Float.
--   
--   <pre>
--   | ...                                                           |   -35
--   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--   | Entry (float)                                                 | 36-39
--   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--   | Exit (float)                                                  | 40-43
--   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--   | Min (float)                                                   | 44-47
--   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--   | Max (float)                                                   | 48-51
--   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--   | Avg (float)                                                   | 52-55
--   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--   | RMS (float)                                                   | 56-59
--   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--   </pre>
--   
--   The table below describes the encoding of SummaryData for Double.
--   
--   <pre>
--   | ...                                                           |   -35
--   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--   | Entry (double)                                                | 36-39
--   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--   |                                                               | 40-43
--   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--   | Exit (double)                                                 | 44-47
--   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--   |                                                               | 48-51
--   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--   | Min (double)                                                  | 52-55
--   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--   |                                                               | 56-59
--   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--   | Max (double)                                                  | 60-63
--   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--   |                                                               | 64-67
--   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--   | Avg (double)                                                  | 68-71
--   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--   |                                                               | 72-75
--   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--   | RMS (double)                                                  | 76-79
--   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--   |                                                               | 80-83
--   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--   </pre>
--   
--   Field encoding formats:
--   
--   <tt>float</tt>: big-endian IEEE 754-2008 binary32 (IEEE 754-1985
--   single) <tt>double</tt>: big-endian IEEE 754-2008 binary64 (IEEE
--   754-1985 double)
module Data.ZoomCache.Numeric.IEEE754
instance ZoomNum Double
instance ZoomWritable Double
instance ZoomWrite (TimeStamp, Double)
instance ZoomWrite Double
instance ZoomReadable Double
instance ZoomNum Float
instance ZoomWritable Float
instance ZoomWrite (TimeStamp, Float)
instance ZoomWrite Float
instance ZoomReadable Float


-- | Default codec implementation for values of type Int. This module
--   implements the interfaces documented in <a>Data.ZoomCache.Codec</a>.
--   View the module source for enlightenment.
--   
--   The table below describes the encoding of SummaryData for Int8:
--   
--   <pre>
--   | ...                                                           |   -35
--   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--   | Entry (int8)  | Exit (int8)   | Min (int8)    | Max (int8)    | 36-39
--   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--   | Avg (double)                                                  | 40-43
--   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--   |                                                               | 44-47
--   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--   | RMS (double)                                                  | 48-51
--   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--   </pre>
--   
--   The table below describes the encoding of SummaryData for Int16:
--   
--   <pre>
--   | ...                                                           |   -35
--   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--   | Entry (int16)                 | Exit (int16)                  | 36-39
--   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--   | Min (int16)                   | Max (int16)                   | 40-43
--   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--   | Avg (double)                                                  | 44-47
--   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--   |                                                               | 48-51
--   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--   | RMS (double)                                                  | 52-55
--   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--   |                                                               | 56-59
--   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--   </pre>
--   
--   The table below describes the encoding of SummaryData for Int and
--   Int32:
--   
--   <pre>
--   | ...                                                           |   -35
--   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--   | Entry (int32)                                                 | 36-39
--   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--   | Exit (int32)                                                  | 40-43
--   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--   | Min (int32)                                                   | 44-47
--   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--   | Max (int32)                                                   | 48-51
--   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--   | Avg (double)                                                  | 52-55
--   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--   |                                                               | 56-59
--   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--   | RMS (double)                                                  | 60-63
--   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--   |                                                               | 64-67
--   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--   </pre>
--   
--   The table below describes the encoding of SummaryData for Int64:
--   
--   <pre>
--   | ...                                                           |   -35
--   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--   | Entry (int64)                                                 | 36-39
--   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--   |                                                               | 40-43
--   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--   | Exit (int64)                                                  | 44-47
--   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--   |                                                               | 48-51
--   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--   | Min (int64)                                                   | 52-55
--   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--   |                                                               | 56-59
--   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--   | Max (int64)                                                   | 60-63
--   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--   |                                                               | 64-67
--   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--   | Avg (int64)                                                   | 68-71
--   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--   |                                                               | 72-75
--   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--   | RMS (int64)                                                   | 76-79
--   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--   |                                                               | 80-83
--   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
--   </pre>
--   
--   Field encoding formats:
--   
--   <tt>int8</tt>: 8bit signed integer
--   
--   <tt>int16</tt>: 16bit big endian signed integer
--   
--   <tt>int32</tt>: 32bit big endian signed integer
--   
--   <tt>int64</tt>: 32bit big endian signed integer
--   
--   <tt>double</tt>: big-endian IEEE 754-2008 binary64 (IEEE 754-1985
--   double)
module Data.ZoomCache.Numeric.Int
instance ZoomNum Int64
instance ZoomWritable Int64
instance ZoomWrite (TimeStamp, Int64)
instance ZoomWrite Int64
instance ZoomReadable Int64
instance ZoomNum Int32
instance ZoomWritable Int32
instance ZoomWrite (TimeStamp, Int32)
instance ZoomWrite Int32
instance ZoomReadable Int32
instance ZoomNum Int16
instance ZoomWritable Int16
instance ZoomWrite (TimeStamp, Int16)
instance ZoomWrite Int16
instance ZoomReadable Int16
instance ZoomNum Int8
instance ZoomWritable Int8
instance ZoomWrite (TimeStamp, Int8)
instance ZoomWrite Int8
instance ZoomReadable Int8
instance ZoomNum Int
instance ZoomWritable Int
instance ZoomWrite (TimeStamp, Int)
instance ZoomWrite Int
instance ZoomReadable Int


-- | API for implementing ZoomCache applications
module Data.ZoomCache
data TimeStamp
TS :: {-# UNPACK #-} !Int64 -> TimeStamp
unTS :: TimeStamp -> {-# UNPACK #-} !Int64
type TrackNo = Int
data Codec

-- | Identify the tracktype corresponding to a given Codec Identifier. When
--   parsing a zoom-cache file, the zoom-cache library will try each of a
--   given list [<tt>IdentifyTrack</tt>].
--   
--   The standard zoom-cache instances are provided in
--   <tt>standardIdentifiers</tt>.
--   
--   When developing your own codecs it is not necessary to build a
--   composite <tt>IdentifyTrack</tt> functions; it is sufficient to
--   generate one for each new codec type. A library of related zoom-cache
--   codecs should export its own [<tt>IdentifyTrack</tt>] functions,
--   usually called something like mylibIdentifiers.
--   
--   These can be generated with <tt>identifyCodec</tt>.
type IdentifyCodec = ByteString -> Maybe Codec

-- | Constant or Variable datarate. For constant datarate, timestamps are
--   implied as incrementing by 1/datarate For variable datarate, explicit
--   timestamps are attached to each datum, encoded as a separate block of
--   timestamps in the Raw Data packet.
data DataRateType
ConstantDR :: DataRateType
VariableDR :: DataRateType

-- | Global and track headers for a zoom-cache file
data CacheFile
CacheFile :: Global -> IntMap TrackSpec -> CacheFile
cfGlobal :: CacheFile -> Global
cfSpecs :: CacheFile -> IntMap TrackSpec

-- | A codec instance must specify a <a>SummaryData</a> type, and implement
--   all methods of this class.
class Typeable a => ZoomReadable a
trackIdentifier :: ZoomReadable a => a -> ByteString
readRaw :: (ZoomReadable a, Nullable s, ListLike s Word8, Functor m, MonadIO m) => Iteratee s m a
readSummary :: (ZoomReadable a, Nullable s, ListLike s Word8, Functor m, MonadIO m) => Iteratee s m (SummaryData a)
prettyRaw :: ZoomReadable a => a -> String
prettySummaryData :: ZoomReadable a => SummaryData a -> String
data ZoomRaw
ZoomRaw :: [a] -> ZoomRaw
data ZoomSummary
ZoomSummary :: (Summary a) -> ZoomSummary
data Packet
Packet :: {-# UNPACK #-} !TrackNo -> {-# UNPACK #-} !TimeStamp -> {-# UNPACK #-} !TimeStamp -> {-# UNPACK #-} !Int -> !ZoomRaw -> ![TimeStamp] -> Packet
packetTrack :: Packet -> {-# UNPACK #-} !TrackNo
packetEntryTime :: Packet -> {-# UNPACK #-} !TimeStamp
packetExitTime :: Packet -> {-# UNPACK #-} !TimeStamp
packetCount :: Packet -> {-# UNPACK #-} !Int
packetData :: Packet -> !ZoomRaw
packetTimeStamps :: Packet -> ![TimeStamp]

-- | A recorded block of summary data
data Summary a
Summary :: {-# UNPACK #-} !TrackNo -> {-# UNPACK #-} !Int -> {-# UNPACK #-} !TimeStamp -> {-# UNPACK #-} !TimeStamp -> !SummaryData a -> Summary a
summaryTrack :: Summary a -> {-# UNPACK #-} !TrackNo
summaryLevel :: Summary a -> {-# UNPACK #-} !Int
summaryEntryTime :: Summary a -> {-# UNPACK #-} !TimeStamp
summaryExitTime :: Summary a -> {-# UNPACK #-} !TimeStamp
summaryData :: Summary a -> !SummaryData a

-- | A map of all track numbers to their <a>TrackSpec</a>
type TrackMap = IntMap TrackSpec

-- | A specification of the type and name of each track
data TrackSpec
TrackSpec :: !Codec -> !DataRateType -> {-# UNPACK #-} !Rational -> !ByteString -> TrackSpec
specType :: TrackSpec -> !Codec
specDRType :: TrackSpec -> !DataRateType
specRate :: TrackSpec -> {-# UNPACK #-} !Rational
specName :: TrackSpec -> !ByteString

-- | The ZoomWrite class provides <a>write</a>, a method to write a Haskell
--   value to an open ZoomCache file.
class ZoomWrite t
write :: ZoomWrite t => TrackNo -> t -> ZoomW ()

-- | A StateT IO monad for writing a ZoomCache file
type ZoomW = StateT ZoomWHandle IO

-- | Run a <tt>ZoomW ()</tt> action on a given file handle, using the
--   specified <a>TrackMap</a> specification
withFileWrite :: TrackMap -> Bool -> ZoomW () -> FilePath -> IO ()

-- | Force a flush of ZoomCache summary blocks to disk. It is not usually
--   necessary to call this function as summary blocks are transparently
--   written at regular intervals.
flush :: ZoomW ()
data ZoomWHandle

-- | Open a new ZoomCache file for writing, using a specified
--   <a>TrackMap</a>.
openWrite :: TrackMap -> Bool -> FilePath -> IO ZoomWHandle
closeWrite :: ZoomWHandle -> IO ()

-- | Query the maximum number of data points to buffer for a given track
--   before forcing a flush of all buffered data and summaries.
watermark :: TrackNo -> ZoomW (Maybe Int)

-- | Set the maximum number of data points to buffer for a given track
--   before forcing a flush of all buffered data and summaries.
setWatermark :: TrackNo -> Int -> ZoomW ()

-- | Create a track map for a stream of a given type, as track no. 1
oneTrack :: ZoomReadable a => a -> DataRateType -> Rational -> ByteString -> TrackMap

-- | <tt>IdentifyTrack</tt> functions provided for standard codecs provided
--   by the zoom-cache library.
standardIdentifiers :: [IdentifyCodec]


-- | Reading of ZoomCache files.
module Data.ZoomCache.Dump
zoomDumpFile :: [IdentifyCodec] -> TrackNo -> FilePath -> IO ()
zoomDumpSummary :: [IdentifyCodec] -> TrackNo -> FilePath -> IO ()
zoomDumpSummaryLevel :: [IdentifyCodec] -> TrackNo -> Int -> FilePath -> IO ()
zoomInfoFile :: [IdentifyCodec] -> FilePath -> IO ()