RIFFFile Class Reference

#include <riff.h>

Inheritance diagram for RIFFFile:

[legend]List of all members.

Public Member Functions
	RIFFFile ()
	Creates the object without an output file.
	RIFFFile (const RIFFFile &)
virtual	~RIFFFile ()
	Destroys the object.
RIFFFile &	operator= (const RIFFFile &)
virtual bool	Open (const char *s)
	Opens the file read only.
virtual bool	Create (const char *s)
	Creates or truncates the file.
virtual void	Close ()
	Destroys the object.
virtual int	AddDirectoryEntry (FOURCC type, FOURCC name, off_t length, int list)
	Adds an entry to the list of containers.
virtual void	SetDirectoryEntry (int i, FOURCC type, FOURCC name, off_t length, off_t offset, int list)
	Modifies an entry.
virtual void	SetDirectoryEntry (int i, RIFFDirEntry &entry)
	Modifies an entry.
virtual void	GetDirectoryEntry (int i, FOURCC &type, FOURCC &name, off_t &length, off_t &offset, int &list) const
	Retrieves an entry.
virtual RIFFDirEntry	GetDirectoryEntry (int i) const
	Retrieves an entry.
virtual off_t	GetFileSize (void) const
	Calculates the total size of the file.
virtual void	PrintDirectoryEntry (int i) const
	prints the attributes of the entry
virtual void	PrintDirectoryEntryData (const RIFFDirEntry &entry) const
	prints the contents of the entry
virtual void	PrintDirectory (void) const
	prints the contents of the whole directory
virtual int	FindDirectoryEntry (FOURCC type, int n=0) const
	finds the index
virtual void	ParseChunk (int parent)
	Reads all items that are contained in one list.
virtual void	ParseList (int parent)
	Reads all items that are contained in one list.
virtual void	ParseRIFF (void)
	Reads the directory structure of the whole RIFF file.
virtual bool	ReadChunk (int chunk_index, void *data, off_t data_len)
	Reads one item including its contents from the RIFF file.
virtual void	WriteChunk (int chunk_index, const void *data)
	Writes one item including its contents to the RIFF file.
virtual void	WriteRIFF (void)
	Writes out the directory structure.
Protected Attributes
int	fd
pthread_mutex_t	file_mutex
Private Attributes
vector< RIFFDirEntry >	directory

---

Constructor & Destructor Documentation

RIFFFile::RIFFFile (   )

Creates the object without an output file. Definition at line 84 of file riff.cc. References file_mutex. : fd( -1 ) { pthread_mutex_init( &file_mutex, NULL ); }

RIFFFile::RIFFFile (  const RIFFFile &   )

Definition at line 95 of file riff.cc. References directory, and fd. : fd( -1 ) { if ( riff.fd != -1 ) { fd = dup( riff.fd ); } directory = riff.directory; }

RIFFFile::~RIFFFile (   )  [virtual]

Destroys the object. If it has an associated opened file, close it. Definition at line 109 of file riff.cc. References Close(), and file_mutex. { Close(); pthread_mutex_destroy( &file_mutex ); }

---

Member Function Documentation

int RIFFFile::AddDirectoryEntry (  FOURCC  type, FOURCC  name, off_t  length, int  list )  [virtual]

Adds an entry to the list of containers. Parameters: type  the type of this entry name  the name length  the length of the data in the container list  the container in which this object is contained. Returns: the ID of the newly created entry The topmost object is not contained in any other container. Use the special ID RIFF_NO_PARENT to create the topmost object. Definition at line 188 of file riff.cc. References directory, GetDirectoryEntry(), RIFFDirEntry::length, RIFFDirEntry::offset, RIFFDirEntry::parent, RIFF_HEADERSIZE, RIFF_NO_PARENT, and SetDirectoryEntry(). Referenced by AVIFile::FlushIndx(), AVI2File::Init(), AVI1File::Init(), ParseChunk(), ParseList(), AVIFile::ParseList(), ParseRIFF(), AVI2File::WriteFrame(), AVI1File::WriteFrame(), AVI2File::WriteRIFF(), and AVI1File::WriteRIFF(). { /* Put all parameters in an RIFFDirEntry object. The offset is currently unknown. */ RIFFDirEntry entry( type, name, length, 0 /* offset */, list ); /* If the new chunk is in a list, then get the offset and size of that list. The offset of this chunk is the end of the list (parent_offset + parent_length) plus the size of the chunk header. */ if ( list != RIFF_NO_PARENT ) { RIFFDirEntry parent = GetDirectoryEntry( list ); entry.offset = parent.offset + parent.length + RIFF_HEADERSIZE; } /* The list which this new chunk is a member of has now increased in size. Get that directory entry and bump up its length by the size of the chunk. Since that list may also be contained in another list, walk up to the top of the tree. */ while ( list != RIFF_NO_PARENT ) { RIFFDirEntry parent = GetDirectoryEntry( list ); parent.length += RIFF_HEADERSIZE + length; SetDirectoryEntry( list, parent ); list = parent.parent; } directory.insert( directory.end(), entry ); return directory.size() - 1; }

void RIFFFile::Close (  void   )  [virtual]

Destroys the object. If it has an associated opened file, close it. Definition at line 167 of file riff.cc. References fd. Referenced by operator=(), and ~RIFFFile(). { if ( fd != -1 ) { close( fd ); fd = -1; } }

bool RIFFFile::Create (  const char *  s  )  [virtual]

Creates or truncates the file. Parameters: s  the filename Definition at line 136 of file riff.cc. References fd. Referenced by AVIHandler::Create(). { fd = open( s, O_RDWR | O_NONBLOCK | O_CREAT | O_TRUNC, 00644 ); if ( fd == -1 ) return false; else return true; }

int RIFFFile::FindDirectoryEntry (  FOURCC  type, int  n = 0 )  const [virtual]

finds the index finds the index of a given directory entry type Todo: inefficient if the directory has lots of items Parameters: type  the type of the entry to find n  the zero-based instance of type to locate Returns: the index of the found object in the directory, or -1 if not found Definition at line 429 of file riff.cc. References count, and directory. Referenced by AVIFile::getStreamFormat(), AVIFile::isOpenDML(), AVIFile::ParseRIFF(), AVIFile::ReadIndex(), AVIFile::setFccHandler(), AVIFile::verifyStream(), and AVIFile::verifyStreamFormat(). { int i, j = 0; int count = directory.size(); for ( i = 0; i < count; ++i ) if ( directory[ i ].type == type ) { if ( j == n ) return i; j++; } return -1; }

RIFFDirEntry RIFFFile::GetDirectoryEntry (  int  i  )  const [virtual]

Retrieves an entry. Gets the whole RIFFDirEntry object. Parameters: i  the ID of the entry to retrieve Returns: the entry Definition at line 296 of file riff.cc. References directory. { assert( i >= 0 && i < ( int ) directory.size() ); return directory[ i ]; }

void RIFFFile::GetDirectoryEntry (  int  i, FOURCC &  type, FOURCC &  name, off_t &  length, off_t &  offset, int &  list )  const [virtual]

Retrieves an entry. Gets the most important member variables. Parameters: i  the ID of the entry to retrieve type  name  length  offset  list  Definition at line 274 of file riff.cc. References directory, RIFFDirEntry::length, RIFFDirEntry::name, RIFFDirEntry::offset, RIFFDirEntry::parent, and RIFFDirEntry::type. Referenced by AddDirectoryEntry(), AVIFile::FlushIndx(), AVIFile::GetDVFrameInfo(), AVIFile::GetFrameInfo(), AVI2File::Init(), AVI1File::Init(), PrintDirectoryEntry(), ReadChunk(), AVIFile::ReadIndex(), AVIFile::UpdateIdx1(), AVIFile::UpdateIndx(), WriteChunk(), AVI2File::WriteFrame(), AVI1File::WriteFrame(), and WriteRIFF(). { RIFFDirEntry entry; assert( i >= 0 && i < ( int ) directory.size() ); entry = directory[ i ]; type = entry.type; name = entry.name; length = entry.length; offset = entry.offset; list = entry.parent; }

off_t RIFFFile::GetFileSize (  void   )  const [virtual]

Calculates the total size of the file. Returns: the size the file in bytes Definition at line 309 of file riff.cc. References directory. Referenced by AVIHandler::GetFileSize(). { /* If we have at least one entry, return the length field of the FILE entry, which is the length of its contents, which is the actual size of whatever is currently in the AVI directory structure. Note that the first entry does not belong to the AVI file. If we don't have any entry, the file size is zero. */ if ( directory.size() > 0 ) return directory[ 0 ].length; else return 0; }

bool RIFFFile::Open (  const char *  s  )  [virtual]

Opens the file read only. Parameters: s  the filename Definition at line 152 of file riff.cc. References fd. Referenced by AVIHandler::Open(). { fd = open( s, O_RDONLY | O_NONBLOCK ); if ( fd == -1 ) return false; else return true; }

RIFFFile & RIFFFile::operator= (  const RIFFFile &   )

Definition at line 116 of file riff.cc. References Close(), directory, and fd. Referenced by AVIFile::operator=(). { if ( fd != riff.fd ) { Close(); if ( riff.fd != -1 ) { fd = dup( riff.fd ); } directory = riff.directory; } return *this; }

void RIFFFile::ParseChunk (  int  parent  )  [virtual]

Reads all items that are contained in one list. Read in one chunk and add it to the directory. If the chunk happens to be of type LIST, then call ParseList recursively for it. Parameters: parent  The id of the item to process Definition at line 455 of file riff.cc. References AddDirectoryEntry(), DWORD, fail_if, fail_neg, fd, FOURCC, make_fourcc(), and ParseList(). Referenced by ParseList(), and AVIFile::ParseList(). { FOURCC type; DWORD length; int typesize; /* Check whether it is a LIST. If so, let ParseList deal with it */ read( fd, &type, sizeof( type ) ); if ( type == make_fourcc( "LIST" ) ) { typesize = -sizeof( type ); fail_if( lseek( fd, typesize, SEEK_CUR ) == ( off_t ) - 1 ); ParseList( parent ); } /* it is a normal chunk, create a new directory entry for it */ else { fail_neg( read( fd, &length, sizeof( length ) ) ); fail_if( length == 0 ); if ( length & 1 ) length++; AddDirectoryEntry( type, 0, length, parent ); fail_if( lseek( fd, length, SEEK_CUR ) == ( off_t ) - 1 ); } }

void RIFFFile::ParseList (  int  parent  )  [virtual]

Reads all items that are contained in one list. Parameters: parent  The id of the list to process Reimplemented in AVIFile. Definition at line 491 of file riff.cc. References AddDirectoryEntry(), DWORD, fail_if, fail_neg, fd, FOURCC, and ParseChunk(). Referenced by ParseChunk(), and ParseRIFF(). { FOURCC type; FOURCC name; int list; DWORD length; off_t pos; off_t listEnd; /* Read in the chunk header (type and length). */ fail_neg( read( fd, &type, sizeof( type ) ) ); fail_neg( read( fd, &length, sizeof( length ) ) ); if ( length & 1 ) length++; /* The contents of the list starts here. Obtain its offset. The list name (4 bytes) is already part of the contents). */ pos = lseek( fd, 0, SEEK_CUR ); fail_if( pos == ( off_t ) - 1 ); fail_neg( read( fd, &name, sizeof( name ) ) ); /* Add an entry for this list. */ list = AddDirectoryEntry( type, name, sizeof( name ), parent ); /* Read in any chunks contained in this list. This list is the parent for all chunks it contains. */ listEnd = pos + length; while ( pos < listEnd ) { ParseChunk( list ); pos = lseek( fd, 0, SEEK_CUR ); fail_if( pos == ( off_t ) - 1 ); } }

void RIFFFile::ParseRIFF (  void   )  [virtual]

Reads the directory structure of the whole RIFF file. Reimplemented in AVIFile. Definition at line 535 of file riff.cc. References AddDirectoryEntry(), DWORD, fail_if, fd, FOURCC, make_fourcc(), ParseList(), RIFF_HEADERSIZE, and RIFF_NO_PARENT. Referenced by AVIFile::ParseRIFF(). { FOURCC type; DWORD length; off_t filesize; off_t pos; int container = AddDirectoryEntry( make_fourcc( "FILE" ), make_fourcc( "FILE" ), 0, RIFF_NO_PARENT ); pos = lseek( fd, 0, SEEK_SET ); /* calculate file size from RIFF header instead from physical file. */ while ( ( read( fd, &type, sizeof( type ) ) > 0 ) && ( read( fd, &length, sizeof( length ) ) > 0 ) && ( type == make_fourcc( "RIFF" ) ) ) { filesize += length + RIFF_HEADERSIZE; fail_if( lseek( fd, pos, SEEK_SET ) == ( off_t ) - 1 ); ParseList( container ); pos = lseek( fd, 0, SEEK_CUR ); fail_if( pos == ( off_t ) - 1 ); } }

void RIFFFile::PrintDirectory (  void   )  const [virtual]

prints the contents of the whole directory Prints a readable representation of the contents of an index. Override this to print out any objects you store in the RIFF file. Parameters: entry  the entry to print Definition at line 410 of file riff.cc. References count, directory, and PrintDirectoryEntry(). { int i; int count = directory.size(); for ( i = 0; i < count; ++i ) PrintDirectoryEntry( i ); }

void RIFFFile::PrintDirectoryEntry (  int  i  )  const [virtual]

prints the attributes of the entry Parameters: i  the ID of the entry to print Definition at line 334 of file riff.cc. References FOURCC, GetDirectoryEntry(), RIFFDirEntry::length, make_fourcc(), RIFFDirEntry::name, RIFFDirEntry::offset, RIFFDirEntry::parent, PrintDirectoryEntryData(), RIFF_NO_PARENT, and RIFFDirEntry::type. Referenced by PrintDirectory(). { RIFFDirEntry entry; RIFFDirEntry parent; FOURCC entry_name; FOURCC list_name; /* Get all attributes of the chunk object. If it is contained in a list, get the name of the list too (otherwise the name of the list is blank). If the chunk object doesn´t have a name (only LISTs and RIFFs have a name), the name is blank. */ entry = GetDirectoryEntry( i ); if ( entry.parent != RIFF_NO_PARENT ) { parent = GetDirectoryEntry( entry.parent ); list_name = parent.name; } else { list_name = make_fourcc( " " ); } if ( entry.name != 0 ) { entry_name = entry.name; } else { entry_name = make_fourcc( " " ); } /* Print out the ascii representation of type and name, as well as length and file offset. */ cout << hex << setfill( '0' ) << "type: " << ((char *)&entry.type)[0] << ((char *)&entry.type)[1] << ((char *)&entry.type)[2] << ((char *)&entry.type)[3] << " name: " << ((char *)&entry_name)[0] << ((char *)&entry_name)[1] << ((char *)&entry_name)[2] << ((char *)&entry_name)[3] << " length: 0x" << setw( 12 ) << entry.length << " offset: 0x" << setw( 12 ) << entry.offset << " list: " << ((char *)&list_name)[0] << ((char *)&list_name)[1] << ((char *)&list_name)[2] << ((char *)&list_name)[3] << dec << endl; /* print the content itself */ PrintDirectoryEntryData( entry ); }

void RIFFFile::PrintDirectoryEntryData (  const RIFFDirEntry &  entry  )  const [virtual]

prints the contents of the entry Prints a readable representation of the contents of an index. Override this to print out any objects you store in the RIFF file. Parameters: entry  the entry to print Reimplemented in AVIFile. Definition at line 399 of file riff.cc. Referenced by PrintDirectoryEntry(). {}

bool RIFFFile::ReadChunk (  int  chunk_index, void *  data, off_t  data_len )  [virtual]

Reads one item including its contents from the RIFF file. Parameters: chunk_index  The index of the item to write data  A pointer to the data Definition at line 569 of file riff.cc. References fail_if, fail_neg, fd, file_mutex, FOURCC, GetDirectoryEntry(), RIFFDirEntry::length, make_fourcc(), RIFFDirEntry::name, RIFFDirEntry::offset, and RIFFDirEntry::type. Referenced by AVIFile::getStreamFormat(), AVIFile::ParseRIFF(), AVIFile::ReadIndex(), AVIFile::setFccHandler(), AVIFile::verifyStream(), and AVIFile::verifyStreamFormat(). { RIFFDirEntry entry; entry = GetDirectoryEntry( chunk_index ); #ifdef DEBUG if ( entry.length > data_len ) { FOURCC entry_name = entry.name ? entry.name : make_fourcc( " " ); cerr << dec << "Warning: insufficient storage in RIFFFile::ReadChunk(): data_len " << data_len << " entry.length " << entry.length << endl; cerr << hex << setfill( '0' ) << " type: " << ((char *)&entry.type)[0] << ((char *)&entry.type)[1] << ((char *)&entry.type)[2] << ((char *)&entry.type)[3] << " name: " << ((char *)&entry_name)[0] << ((char *)&entry_name)[1] << ((char *)&entry_name)[2] << ((char *)&entry_name)[3] << " length: 0x" << setw( 12 ) << entry.length << " offset: 0x" << setw( 12 ) << entry.offset << endl; } #endif pthread_mutex_lock( &file_mutex ); fail_if( lseek( fd, entry.offset, SEEK_SET ) == ( off_t ) - 1 ); fail_neg( read( fd, data, entry.length > data_len ? data_len : entry.length ) ); pthread_mutex_unlock( &file_mutex ); return ( entry.length <= data_len ); }

void RIFFFile::SetDirectoryEntry (  int  i, RIFFDirEntry &  entry )  [virtual]

Modifies an entry. The entry.written flag is set to false because the contents has been modified Parameters: i  the ID of the entry which is to modify entry  the new entry Note: Do not change length, offset, or the parent container. Do not change an empty name ("") to a name and vice versa Definition at line 254 of file riff.cc. References directory, and RIFFDirEntry::written. { assert( i >= 0 && i < ( int ) directory.size() ); entry.written = false; directory[ i ] = entry; }

void RIFFFile::SetDirectoryEntry (  int  i, FOURCC  type, FOURCC  name, off_t  length, off_t  offset, int  list )  [virtual]

Modifies an entry. Parameters: i  the ID of the entry which is to modify type  the type of this entry name  the name length  the length of the data in the container list  the container in which this object is contained. Note: Do not change length, offset, or the parent container. Do not change an empty name ("") to a name and vice versa Definition at line 235 of file riff.cc. References directory. Referenced by AddDirectoryEntry(). { RIFFDirEntry entry( type, name, length, offset, list ); assert( i >= 0 && i < ( int ) directory.size() ); directory[ i ] = entry; }

void RIFFFile::WriteChunk (  int  chunk_index, const void *  data )  [virtual]

Writes one item including its contents to the RIFF file. Parameters: chunk_index  The index of the item to write data  A pointer to the data Definition at line 610 of file riff.cc. References directory, DWORD, fail_if, fail_neg, fd, file_mutex, GetDirectoryEntry(), RIFFDirEntry::length, RIFFDirEntry::offset, RIFF_HEADERSIZE, and RIFFDirEntry::type. Referenced by AVIFile::FlushIndx(), AVI2File::WriteFrame(), AVI1File::WriteFrame(), AVI2File::WriteRIFF(), and AVI1File::WriteRIFF(). { RIFFDirEntry entry; entry = GetDirectoryEntry( chunk_index ); pthread_mutex_lock( &file_mutex ); fail_if( lseek( fd, entry.offset - RIFF_HEADERSIZE, SEEK_SET ) == ( off_t ) - 1 ); fail_neg( write( fd, &entry.type, sizeof( entry.type ) ) ); DWORD length = entry.length; fail_neg( write( fd, &length, sizeof( length ) ) ); fail_neg( write( fd, data, entry.length ) ); pthread_mutex_unlock( &file_mutex ); /* Remember that this entry already has been written. */ directory[ chunk_index ].written = true; }

void RIFFFile::WriteRIFF (  void   )  [virtual]

Writes out the directory structure. For all items in the directory list that have not been written yet, it seeks to the file position where that item should be stored and writes the type and length field. If the item has a name, it will also write the name field. Note: It does not write the contents of any item. Use WriteChunk to do that. Reimplemented in AVIFile, AVI1File, and AVI2File. Definition at line 638 of file riff.cc. References count, directory, DWORD, fail_if, fail_neg, fd, GetDirectoryEntry(), RIFFDirEntry::length, RIFFDirEntry::name, RIFFDirEntry::offset, RIFF_HEADERSIZE, RIFFDirEntry::type, and RIFFDirEntry::written. Referenced by AVI2File::WriteRIFF(), and AVI1File::WriteRIFF(). { int i; RIFFDirEntry entry; int count = directory.size(); /* Start at the second entry (RIFF), since the first entry (FILE) is needed only for internal purposes and is not written to the file. */ for ( i = 1; i < count; ++i ) { /* Only deal with entries that haven´t been written */ entry = GetDirectoryEntry( i ); if ( entry.written == false ) { /* A chunk entry consist of its type and length, a list entry has an additional name. Look up the entry, seek to the start of the header, which is at the offset of the data start minus the header size and write out the items. */ fail_if( lseek( fd, entry.offset - RIFF_HEADERSIZE, SEEK_SET ) == ( off_t ) - 1 ) ; fail_neg( write( fd, &entry.type, sizeof( entry.type ) ) ); DWORD length = entry.length; fail_neg( write( fd, &length, sizeof( length ) ) ); /* If it has a name, it is a list. Write out the extra name field. */ if ( entry.name != 0 ) { fail_neg( write( fd, &entry.name, sizeof( entry.name ) ) ); } /* Remember that this entry already has been written. */ directory[ i ].written = true; } } }

---

Member Data Documentation

vector<RIFFDirEntry> RIFFFile::directory [private]

Definition at line 97 of file riff.h. Referenced by AddDirectoryEntry(), FindDirectoryEntry(), GetDirectoryEntry(), GetFileSize(), operator=(), PrintDirectory(), RIFFFile(), SetDirectoryEntry(), WriteChunk(), and WriteRIFF().

int RIFFFile::fd [protected]

Definition at line 93 of file riff.h. Referenced by Close(), Create(), AVIFile::GetDVFrame(), AVIFile::GetDVFrameInfo(), AVIFile::getFrame(), AVIFile::GetFrameInfo(), AVIFile::getStreamFormat(), Open(), operator=(), ParseChunk(), ParseList(), AVIFile::ParseList(), ParseRIFF(), AVIFile::PrintDirectoryEntryData(), ReadChunk(), RIFFFile(), WriteChunk(), and WriteRIFF().

pthread_mutex_t RIFFFile::file_mutex [protected]

Definition at line 94 of file riff.h. Referenced by AVIFile::GetDVFrame(), AVIFile::getFrame(), AVIFile::getStreamFormat(), ReadChunk(), RIFFFile(), WriteChunk(), and ~RIFFFile().

---

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

• riff.h
• riff.cc

---