annotate data/fileio/QuickTimeFileReader.h @ 537:3cc4b7cd2aa5

* Merge from one-fftdataserver-per-fftmodel branch.  This bit of
reworking (which is not described very accurately by the title of
the branch) turns the MatrixFile object into something that either
reads or writes, but not both, and separates the FFT file cache
reader and writer implementations separately.  This allows the
FFT data server to have a single thread owning writers and one reader
per "customer" thread, and for all locking to be vastly simplified
and concentrated in the data server alone (because none of the
classes it makes use of is used in more than one thread at a time).
The result is faster and more trustworthy code.

/* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */

/*
    Sonic Visualiser
    An audio file viewer and annotation editor.
    Centre for Digital Music, Queen Mary, University of London.
    This file copyright 2006-2007 Chris Cannam and QMUL.

    Based in part on QTAudioFile.h from SoundBite, copyright 2006
    Chris Sutton and Mark Levy.
    
    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 2 of the
    License, or (at your option) any later version.  See the file
    COPYING included with this distribution for more information.
*/

#ifndef _QUICKTIME_FILE_READER_H_
#define _QUICKTIME_FILE_READER_H_

#ifdef HAVE_QUICKTIME

#include "CodedAudioFileReader.h"

#include "base/Thread.h"

#include <set>

class ProgressReporter;

class QuickTimeFileReader : public CodedAudioFileReader
{
    Q_OBJECT

public:
    enum DecodeMode {
        DecodeAtOnce, // decode the file on construction, with progress
        DecodeThreaded // decode in a background thread after construction
    };

    QuickTimeFileReader(FileSource source,
                        DecodeMode decodeMode,
                        CacheMode cacheMode,
                        size_t targetRate = 0,
                        ProgressReporter *reporter = 0);
    virtual ~QuickTimeFileReader();

    virtual QString getError() const { return m_error; }
    virtual QString getLocation() const { return m_source.getLocation(); }
    virtual QString getTitle() const { return m_title; }
    
    static void getSupportedExtensions(std::set<QString> &extensions);
    static bool supportsExtension(QString ext);
    static bool supportsContentType(QString type);
    static bool supports(FileSource &source);

    virtual int getDecodeCompletion() const { return m_completion; }

    virtual bool isUpdating() const {
        return m_decodeThread && m_decodeThread->isRunning();
    }

public slots:
    void cancelled();

protected:
    FileSource m_source;
    QString m_path;
    QString m_error;
    QString m_title;

    class D;
    D *m_d;

    ProgressReporter *m_reporter;
    bool m_cancelled;
    int m_completion;

    class DecodeThread : public Thread
    {
    public:
        DecodeThread(QuickTimeFileReader *reader) : m_reader(reader) { }
        virtual void run();

    protected:
        QuickTimeFileReader *m_reader; 
    };

    DecodeThread *m_decodeThread;
};

#endif

#endif