Kwave::VirtualAudioFile Class Reference

#include <VirtualAudioFile.h>

Inheritance diagram for Kwave::VirtualAudioFile:

Collaboration diagram for Kwave::VirtualAudioFile:

Public Member Functions
	VirtualAudioFile (QIODevice &device)
virtual	~VirtualAudioFile ()
virtual void	open (Kwave::VirtualAudioFile *x, AFfilesetup setup)
virtual void	close ()
AFfilehandle &	handle ()
AFvirtualfile *	file ()
long int	lastError ()
QString	lastErrorText ()
virtual qint64	read (char *data, unsigned int nbytes)
virtual qint64	length ()
virtual qint64	write (const char *data, unsigned int nbytes)
virtual void	destroy ()
virtual qint64	seek (qint64 offset, bool is_relative)
virtual qint64	tell ()

Static Public Member Functions
static Kwave::VirtualAudioFile *	adapter (AFvirtualfile *vfile)

Private Attributes
QIODevice &	m_device
AFfilehandle	m_file_handle
AFvirtualfile *	m_virtual_file
long int	m_last_error
QString	m_last_error_text

Detailed Description

This class builds an interface between a QIODevice and a virtual file in libaudiofile.

Definition at line 40 of file VirtualAudioFile.h.

Constructor & Destructor Documentation

VirtualAudioFile()

Kwave::VirtualAudioFile::VirtualAudioFile ( QIODevice &  device )

explicit

Constructor

Parameters

device

QIODevice used as source/destination

Definition at line 136 of file VirtualAudioFile.cpp.

References __af_virtual_file_new(), af_file_destroy(), af_file_length(), af_file_read(), af_file_seek(), af_file_tell(), af_file_write(), and m_virtual_file.

     :m_device(device), m_file_handle(Q_NULLPTR), m_virtual_file(Q_NULLPTR),
      m_last_error(-1), m_last_error_text()
{
    // create the virtual file structure for libaudiofile
    m_virtual_file = __af_virtual_file_new();
    Q_ASSERT(m_virtual_file);
    if (!m_virtual_file) return;

    // enter our wrapper functions
    m_virtual_file->closure = Q_NULLPTR;
    m_virtual_file->read    = af_file_read;
    m_virtual_file->write   = af_file_write;
    m_virtual_file->length  = af_file_length;
    m_virtual_file->destroy = af_file_destroy;
    m_virtual_file->seek    = af_file_seek;
    m_virtual_file->tell    = af_file_tell;
}

Here is the call graph for this function:

~VirtualAudioFile()

Kwave::VirtualAudioFile::~VirtualAudioFile ( )

virtual

Destructor

Definition at line 200 of file VirtualAudioFile.cpp.

References close(), and m_virtual_file.

{
    if (m_virtual_file) close();
}

Here is the call graph for this function:

Member Function Documentation

adapter()

Kwave::VirtualAudioFile * Kwave::VirtualAudioFile::adapter ( AFvirtualfile *  vfile )

static

returns a VirtualAudioFile for a libasound virtual file

Definition at line 249 of file VirtualAudioFile.cpp.

References _adapter_map.

Referenced by af_file_length(), af_file_read(), af_file_seek(), af_file_tell(), af_file_write(), and open().

{
    // create a new empty map if necessary
    if (!_adapter_map) _adapter_map =
        new QMap<AFvirtualfile*,VirtualAudioFile*>();
    Q_ASSERT(_adapter_map);
    if (!_adapter_map) return Q_NULLPTR;

    // lookup in the map
    return _adapter_map->contains(vfile) ? (*_adapter_map)[vfile] : Q_NULLPTR;
}

Here is the caller graph for this function:

close()

void Kwave::VirtualAudioFile::close ( )

virtual

Closes the file from libaudiofile side. The associated QIODevice will not be touched.

Note

This has not necessarily to be called, it will closed automatically in the destructor.

Definition at line 187 of file VirtualAudioFile.cpp.

References _adapter_map, m_file_handle, and m_virtual_file.

Referenced by Kwave::WavEncoder::encode(), and ~VirtualAudioFile().

{
    // close libaudiofile stuff
    afCloseFile(m_file_handle);

    // de-register ourself
    if (_adapter_map) _adapter_map->remove(m_virtual_file);

    m_virtual_file = Q_NULLPTR;
    m_file_handle  = Q_NULLPTR;
}

Here is the caller graph for this function:

destroy()

void Kwave::VirtualAudioFile::destroy ( )

virtual

called to close the source

Definition at line 228 of file VirtualAudioFile.cpp.

{
}

file()

AFvirtualfile* Kwave::VirtualAudioFile::file ( )

inline

Returns the virtual file for use in libaudiofile

Definition at line 67 of file VirtualAudioFile.h.

{ return m_virtual_file; }

handle()

AFfilehandle& Kwave::VirtualAudioFile::handle ( )

inline

Returns the handle for use in libaudiofile

Definition at line 64 of file VirtualAudioFile.h.

Referenced by Kwave::AudiofileDecoder::decode(), Kwave::WavDecoder::decode(), Kwave::WavEncoder::encode(), Kwave::AudiofileDecoder::open(), and Kwave::WavDecoder::open().

{ return m_file_handle; }

Here is the caller graph for this function:

lastError()

long int Kwave::VirtualAudioFile::lastError ( )

inline

Returns the last error from libaudiofile (-1 means "no error")

Definition at line 70 of file VirtualAudioFile.h.

Referenced by Kwave::WavEncoder::encode(), Kwave::AudiofileDecoder::open(), and Kwave::WavDecoder::open().

{ return m_last_error; }

Here is the caller graph for this function:

lastErrorText()

QString Kwave::VirtualAudioFile::lastErrorText ( )

inline

returns the last error text from libaudiofile, not localized

Note

this is only valid in case of lastError is not -1

Definition at line 76 of file VirtualAudioFile.h.

Referenced by Kwave::WavDecoder::open().

{ return m_last_error_text; }

Here is the caller graph for this function:

length()

qint64 Kwave::VirtualAudioFile::length ( )

virtual

returns the length of the file

Reimplemented in Kwave::RepairVirtualAudioFile.

Definition at line 214 of file VirtualAudioFile.cpp.

References m_device.

Referenced by af_file_length().

{
    return m_device.size();
}

Here is the caller graph for this function:

open()

void Kwave::VirtualAudioFile::open ( Kwave::VirtualAudioFile *  x, AFfilesetup  setup  )

virtual

opens the file through libaudiofile

Definition at line 156 of file VirtualAudioFile.cpp.

References _adapter_map, _handle_audiofile_error(), _last_audiofile_error_text, _lastAudiofileError(), adapter(), m_device, m_file_handle, m_last_error, m_last_error_text, and m_virtual_file.

Referenced by Kwave::WavEncoder::encode(), Kwave::AudiofileDecoder::open(), and Kwave::WavDecoder::open().

{
    // register ourself
    adapter(Q_NULLPTR); // dummy lookup, for creating a new map if needed
    Q_ASSERT(_adapter_map);
    if (_adapter_map) _adapter_map->insert(m_virtual_file, x);

    // determine the mode: rw/w/r
    const char *mode = Q_NULLPTR;
    if      (m_device.isWritable()) mode = "w";
    else if (m_device.isReadable()) mode = "r";
    Q_ASSERT(mode);

    AFerrfunc old_handler;
    old_handler = afSetErrorHandler(_handle_audiofile_error);

    // reset the file position when opening the device, otherwise libaudiofile
    // might fail when seeking to the current position and the position of
    // the device currently is at EOF (in libaudiofile, File::canSeek)
    m_device.seek(0);

    // open the virtual file and get a handle for it
    m_file_handle     = afOpenVirtualFile(m_virtual_file, mode, setup);
    m_last_error      = _lastAudiofileError();
    m_last_error_text = _last_audiofile_error_text;

    afSetErrorHandler(old_handler);
}

Here is the call graph for this function:

Here is the caller graph for this function:

read()

qint64 Kwave::VirtualAudioFile::read ( char *  data, unsigned int  nbytes  )

virtual

reads a block of data

Reimplemented in Kwave::RepairVirtualAudioFile.

Definition at line 206 of file VirtualAudioFile.cpp.

References m_device.

Referenced by af_file_read().

{
    Q_ASSERT(data);
    if (!data) return 0;
    return m_device.read(data, nbytes);
}

Here is the caller graph for this function:

seek()

qint64 Kwave::VirtualAudioFile::seek ( qint64  offset, bool  is_relative  )

virtual

seek to a file position

Reimplemented in Kwave::RepairVirtualAudioFile.

Definition at line 233 of file VirtualAudioFile.cpp.

References m_device.

Referenced by af_file_seek().

{
    qint64 abs_pos = (is_relative) ? (m_device.pos() + offset) : offset;
    if (abs_pos >= m_device.size())
        return -1; // avoid seek after EOF
    bool ok = m_device.seek(abs_pos);
    return (ok) ? m_device.pos() : -1;
}

Here is the caller graph for this function:

tell()

qint64 Kwave::VirtualAudioFile::tell ( )

virtual

returns the file position

Reimplemented in Kwave::RepairVirtualAudioFile.

Definition at line 243 of file VirtualAudioFile.cpp.

References m_device.

Referenced by af_file_tell().

{
    return m_device.pos();
}

Here is the caller graph for this function:

write()

qint64 Kwave::VirtualAudioFile::write ( const char *  data, unsigned int  nbytes  )

virtual

writes a block of data

Reimplemented in Kwave::RepairVirtualAudioFile.

Definition at line 220 of file VirtualAudioFile.cpp.

References m_device.

Referenced by af_file_write().

{
    Q_ASSERT(data);
    if (!data) return 0;
    return m_device.write(data, nbytes);
}

Here is the caller graph for this function:

Member Data Documentation

m_device

QIODevice& Kwave::VirtualAudioFile::m_device

private

i/o device to Qt

Definition at line 102 of file VirtualAudioFile.h.

Referenced by length(), open(), read(), seek(), tell(), and write().

m_file_handle

AFfilehandle Kwave::VirtualAudioFile::m_file_handle

private

file handle used in libaudiofile

Definition at line 105 of file VirtualAudioFile.h.

Referenced by close(), and open().

m_last_error

long int Kwave::VirtualAudioFile::m_last_error

private

last error code from libaudiofile

Definition at line 111 of file VirtualAudioFile.h.

Referenced by open().

m_last_error_text

QString Kwave::VirtualAudioFile::m_last_error_text

private

last error text from libaudiofile

Definition at line 114 of file VirtualAudioFile.h.

Referenced by open().

m_virtual_file

AFvirtualfile* Kwave::VirtualAudioFile::m_virtual_file

private

virtual file, used in libaudiofile

Definition at line 108 of file VirtualAudioFile.h.

Referenced by close(), open(), VirtualAudioFile(), and ~VirtualAudioFile().

---

The documentation for this class was generated from the following files:

• libkwave/VirtualAudioFile.h
• libkwave/VirtualAudioFile.cpp