DLS::Info Class Reference

Optional information for DLS files, instruments, samples, etc. More...

#include <DLS.h>

Inheritance diagram for DLS::Info:

Public Member Functions
	Info (RIFF::List *list)
	Constructor. More...
void	SetFixedStringLengths (const string_length_t *lengths)
	Forces specific Info fields to be of a fixed length when being saved to a file. More...
virtual void	UpdateChunks (progress_t *pProgress)
	Update chunks with current info values. More...
virtual void	DeleteChunks ()
	Remove all RIFF chunks associated with this Info object. More...
virtual void	CopyAssign (const Info *orig)
	Make a deep copy of the Info object given by orig and assign it to this object. More...

Public Attributes
String	Name
	<INAM-ck>. Stores the title of the subject of the file, such as, Seattle From Above.
String	ArchivalLocation
	<IARL-ck>. Indicates where the subject of the file is stored.
String	CreationDate
	<ICRD-ck>. Specifies the date the subject of the file was created. List dates in yyyy-mm-dd format.
String	Comments
	<ICMT-ck>. Provides general comments about the file or the subject of the file. Sentences might end with semicolon.
String	Product
	<IPRD-ck>. Specifies the name of the title the file was originally intended for, such as World Ruler V.
String	Copyright
	<ICOP-ck>. Records the copyright information for the file.
String	Artists
	<IART-ck>. Lists the artist of the original subject of the file.
String	Genre
	<IGNR-ck>. Descirbes the original work, such as, Jazz, Classic, Rock, Techno, Rave, etc.
String	Keywords
	<IKEY-ck>. Provides a list of keywords that refer to the file or subject of the file. Keywords are separated with semicolon and blank, e.g., FX; death; murder.
String	Engineer
	<IENG-ck>. Stores the name of the engineer who worked on the file. Multiple engineer names are separated by semicolon and blank, e.g, Smith, John; Adams, Joe.
String	Technician
	<ITCH-ck>. Identifies the technician who sampled the subject file.
String	Software
	<ISFT-ck>. Identifies the name of the sofware package used to create the file.
String	Medium
	<IMED-ck>. Describes the original subject of the file, such as, record, CD, and so forth.
String	Source
	<ISRC-ck>. Identifies the name of the person or organization who supplied the original subject of the file.
String	SourceForm
	<ISRF-ck>. Identifies the original form of the material that was digitized, such as record, sampling CD, TV sound track. This is not neccessarily the same as Medium.
String	Commissioned
	<ICMS-ck>. Lists the name of the person or organization that commissioned the subject of the file, e.g., Pope Julian II.
String	Subject
	<ISBJ-ck>. Describes the contents of the file.
bool	UseFixedLengthStrings

Detailed Description

Optional information for DLS files, instruments, samples, etc.

Definition at line 362 of file DLS.h.

Constructor & Destructor Documentation

Info()

DLS::Info::Info

(

RIFF::List *

list

)

Constructor.

Initializes the info strings with values provided by an INFO list chunk.

Parameters

list	- pointer to a list chunk which contains an INFO list chunk

Definition at line 285 of file DLS.cpp.

References ArchivalLocation, Artists, Comments, Commissioned, Copyright, CreationDate, Engineer, Genre, RIFF::List::GetSubList(), Keywords, Medium, Name, Product, Software, Source, SourceForm, Subject, and Technician.

Member Function Documentation

CopyAssign()

void DLS::Info::CopyAssign ( const Info *  orig )

virtual

Make a deep copy of the Info object given by orig and assign it to this object.

Parameters

orig	- original Info object to be copied from

Definition at line 450 of file DLS.cpp.

References ArchivalLocation, Artists, Comments, Commissioned, Copyright, CreationDate, Engineer, Genre, Keywords, Medium, Name, Product, Software, Source, SourceForm, Subject, and Technician.

Referenced by DLS::Resource::CopyAssign().

DeleteChunks()

void DLS::Info::DeleteChunks ( )

virtual

Remove all RIFF chunks associated with this Info object.

At the moment Info::DeleteChunks() does nothing. It is recommended to call this method explicitly though from deriving classes's own overridden implementation of this method to avoid potential future compatiblity issues.

See Storage::DeleteChunks() for details.

Implements DLS::Storage.

Definition at line 441 of file DLS.cpp.

SetFixedStringLengths()

void DLS::Info::SetFixedStringLengths

(

const string_length_t *

lengths

)

Forces specific Info fields to be of a fixed length when being saved to a file.

By default the respective RIFF chunk of an Info field will have a size analogue to its actual string length. With this method however this behavior can be overridden, allowing to force an arbitrary fixed size individually for each Info field.

This method is used as a workaround for the gig format, not for DLS.

Parameters

lengths

- NULL terminated array of string_length_t elements

Definition at line 326 of file DLS.cpp.

Referenced by gig::Sample::Sample().

UpdateChunks()

void DLS::Info::UpdateChunks ( progress_t *  pProgress )

virtual

Update chunks with current info values.

Apply current INFO field values to the respective INFO chunks. You have to call File::Save() to make changes persistent.

Parameters

pProgress

- callback function for progress notification

Implements DLS::Storage.

Definition at line 376 of file DLS.cpp.

References RIFF::List::AddSubList(), ArchivalLocation, Artists, Comments, Commissioned, Copyright, CreationDate, Engineer, Genre, RIFF::List::GetListType(), RIFF::List::GetSubList(), Keywords, DLS::libraryName(), DLS::libraryVersion(), Medium, Name, Product, Software, Source, SourceForm, Subject, and Technician.

Referenced by DLS::Resource::UpdateChunks().

Member Data Documentation

UseFixedLengthStrings

bool DLS::Info::UseFixedLengthStrings

Deprecated:

Not used anymore, use SetFixedStringLengths() instead.

Definition at line 381 of file DLS.h.

---

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

• DLS.h
• DLS.cpp