ITAFileDataSource.h 2.92 KB
Newer Older
Jonas Stienen's avatar
Jonas Stienen committed
1 2 3 4 5
/*
* ----------------------------------------------------------------
*
*		ITA core libs
*		(c) Copyright Institute of Technical Acoustics (ITA)
6
*		RWTH Aachen University, Germany, 2015-2017
Jonas Stienen's avatar
Jonas Stienen committed
7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24
*
* ----------------------------------------------------------------
*				    ____  __________  _______
*				   //  / //__   ___/ //  _   |
*				  //  /    //  /    //  /_|  |
*				 //  /    //  /    //  ___   |
*				//__/    //__/    //__/   |__|
*
* ----------------------------------------------------------------
*
*/
// $Id: ITAFileDataSource.h 2900 2012-09-17 08:42:42Z stienen $

#ifndef INCLUDE_WATCHER_ITA_FILE_DATA_SOURCE
#define INCLUDE_WATCHER_ITA_FILE_DATA_SOURCE

#include <ITADataSourcesDefinitions.h>
          
25
#include "ITABufferDataSource.h"
Jonas Stienen's avatar
Jonas Stienen committed
26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51
              
#include <string>		// Strings der Standard Template Library (STL)
#include <vector>

//! Audiodatei-Datenquelle
/**
 * Die Klasse ITAFileDatasource realisiert eine Datenquelle, welche
 * die Audiodaten aus einer Audiodatei freisetzt. Bei der Erzeugung
 * von Instanzen der Klasse lädt der Konstruktor die Audiodatei
 * vollständig in den Speicher. Die Anzahl der Samples in der Audiodatei -
 * auch Kapazität der Audiodatei genannt - wird dabei, durch das Anhängen
 * von Nullsamples, auf ein ganzzahliges Vielfaches der Blocklänge ergänzt.
 * So ergibt sich eine Kapazität der Datenquelle, d.h. die Anzahl an Samples
 * die die Datenquelle freisetzt. Diese kann durch das ggf. Anhängen der
 * Nullsamples ein anderer Wert sein als die Kapazität der Eingabedatei.
 * 
 * Ist das Ende der Audiodaten erreicht, gibt die Datenquelle keine Daten
 * mehr zurück (Nullzeiger). Im Wiederholungsmodus springt die
 * Datenquelle nach der Freisetzung des letzten Blocks Audiodaten
 * wieder zurück an den Anfang (Hinweis: Aufgrund der Erweiterung
 * der Audiodaten auf ein Vielfaches der Blocklänge finden Sie das
 * erste Sample der Audiodaten stets am Offset 0 des entsprechenden
 * (wiederholten) Blockes. Die Datenquelle kann manuell zurückgespult werden.
 *
 * \ingroup datasources
 */
52 53
class ITA_DATA_SOURCES_API ITAFileDatasource : public ITABufferDatasource
{
Jonas Stienen's avatar
Jonas Stienen committed
54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84
public:
	//! Konstruktor
	/**
	 * \param sFilename	Dateiname der Audiodatei
	 * \param uiBlocklength Blocklänge
	 * \param bLoopMode Wiederholungsmodus (Optional)
	 *
	 * \note Bei Fehlern werden ISPL::Exceptions aufgelöst.
	 */
	ITAFileDatasource(std::string sFilename,
		              unsigned int uiBlocklength,
				      bool bLoopMode=false);	

	//! Destruktor
	virtual ~ITAFileDatasource();

	//! Dateinamen der Audiodatei zurückgeben
	std::string GetFileName() const;

	//! Kapazität der Eingabedatei zurückgeben
	/** 
	 * Gibt die Anzahl der Samples in der Eingabedatei zurück.
	 */
	unsigned int GetFileCapacity() const;

private:	
	std::string m_sFilename;			// Dateiname der Audiodatei
	unsigned int m_uiFileCapacity;		// Kapazität des Eingabedatei
	std::vector<float*> vpfData;		// Datenpuffer (Kanalweise)
};

85
#endif // INCLUDE_WATCHER_ITA_FILE_DATA_SOURCE