annotate data/fileio/OggVorbisFileReader.h @ 490:c3fb8258e34d

* Make it possible to import an entire session from an RDF document.
  However, at the moment the timings of events appear to be constrained
  by how far the audio decoder has got through its audio file at the
  time the event is queried -- need to investigate.

/* -*- 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 Chris Cannam.
    
    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 _OGG_VORBIS_FILE_READER_H_
#define _OGG_VORBIS_FILE_READER_H_

#ifdef HAVE_OGGZ
#ifdef HAVE_FISHSOUND

#include "CodedAudioFileReader.h"

#include "base/Thread.h"
#include <oggz/oggz.h>
#include <fishsound/fishsound.h>

#include <set>

class ProgressReporter;

class OggVorbisFileReader : public CodedAudioFileReader
{
    Q_OBJECT

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

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

    virtual QString getError() const { return m_error; }

    virtual QString getLocation() const { return m_source.getLocation(); }
    virtual QString getTitle() const { return m_title; }
    virtual QString getMaker() const { return m_maker; }
    
    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;
    QString m_maker;

    OGGZ *m_oggz;
    FishSound *m_fishSound;
    ProgressReporter *m_reporter;
    size_t m_fileSize;
    size_t m_bytesRead;
    bool m_commentsRead;
    bool m_cancelled;
    int m_completion;
 
    static int readPacket(OGGZ *, ogg_packet *, long, void *);
    static int acceptFrames(FishSound *, float **, long, void *);

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

    protected:
        OggVorbisFileReader *m_reader; 
    };

    DecodeThread *m_decodeThread;
};

#endif
#endif

#endif