DLS::Info Class Reference

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

#include <DLS.h>

List of all members.

Public Member Functions

 Info (RIFF::List *list)
 Constructor.
void SetFixedStringLengths (const string_length_t *lengths)
 Forces specific Info fields to be of a fixed length when being saved to a file.
virtual ~Info ()
virtual void UpdateChunks ()
 Update chunks with current info values.

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

Classes

struct  string_length_t


Detailed Description

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

Definition at line 284 of file DLS.h.


Constructor & Destructor Documentation

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 242 of file DLS.cpp.

References ArchivalLocation, Artists, CHUNK_ID_IARL, CHUNK_ID_IART, CHUNK_ID_ICMS, CHUNK_ID_ICMT, CHUNK_ID_ICOP, CHUNK_ID_ICRD, CHUNK_ID_IENG, CHUNK_ID_IGNR, CHUNK_ID_IKEY, CHUNK_ID_IMED, CHUNK_ID_INAM, CHUNK_ID_IPRD, CHUNK_ID_ISBJ, CHUNK_ID_ISFT, CHUNK_ID_ISRC, CHUNK_ID_ISRF, CHUNK_ID_ITCH, Comments, Commissioned, Copyright, CreationDate, Engineer, Genre, RIFF::List::GetSubList(), Keywords, LIST_TYPE_INFO, Medium, Name, Product, Software, Source, SourceForm, Subject, and Technician.

DLS::Info::~Info (  )  [virtual]

Definition at line 269 of file DLS.cpp.


Member Function Documentation

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 283 of file DLS.cpp.

void DLS::Info::UpdateChunks (  )  [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.

Definition at line 331 of file DLS.cpp.

References RIFF::List::AddSubList(), ArchivalLocation, Artists, CHUNK_ID_IARL, CHUNK_ID_IART, CHUNK_ID_ICMS, CHUNK_ID_ICMT, CHUNK_ID_ICOP, CHUNK_ID_ICRD, CHUNK_ID_IENG, CHUNK_ID_IGNR, CHUNK_ID_IKEY, CHUNK_ID_IMED, CHUNK_ID_INAM, CHUNK_ID_IPRD, CHUNK_ID_ISBJ, CHUNK_ID_ISFT, CHUNK_ID_ISRC, CHUNK_ID_ISRF, CHUNK_ID_ITCH, Comments, Commissioned, Copyright, CreationDate, Engineer, Genre, RIFF::List::GetListType(), RIFF::List::GetSubList(), Keywords, DLS::libraryName(), DLS::libraryVersion(), LIST_TYPE_INFO, LIST_TYPE_INS, Medium, Name, Product, RIFF_TYPE_DLS, Software, Source, SourceForm, Subject, and Technician.

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


Member Data Documentation

String DLS::Info::Name

<INAM-ck>. Stores the title of the subject of the file, such as, Seattle From Above.

Definition at line 286 of file DLS.h.

Referenced by Info(), and UpdateChunks().

String DLS::Info::ArchivalLocation

<IARL-ck>. Indicates where the subject of the file is stored.

Definition at line 287 of file DLS.h.

Referenced by Info(), and UpdateChunks().

String DLS::Info::CreationDate

<ICRD-ck>. Specifies the date the subject of the file was created. List dates in yyyy-mm-dd format.

Definition at line 288 of file DLS.h.

Referenced by Info(), and UpdateChunks().

String DLS::Info::Comments

<ICMT-ck>. Provides general comments about the file or the subject of the file. Sentences might end with semicolon.

Definition at line 289 of file DLS.h.

Referenced by Info(), and UpdateChunks().

String DLS::Info::Product

<IPRD-ck>. Specifies the name of the title the file was originally intended for, such as World Ruler V.

Definition at line 290 of file DLS.h.

Referenced by Info(), and UpdateChunks().

String DLS::Info::Copyright

<ICOP-ck>. Records the copyright information for the file.

Definition at line 291 of file DLS.h.

Referenced by Info(), and UpdateChunks().

String DLS::Info::Artists

<IART-ck>. Lists the artist of the original subject of the file.

Definition at line 292 of file DLS.h.

Referenced by Info(), and UpdateChunks().

String DLS::Info::Genre

<IGNR-ck>. Descirbes the original work, such as, Jazz, Classic, Rock, Techno, Rave, etc.

Definition at line 293 of file DLS.h.

Referenced by Info(), and UpdateChunks().

String DLS::Info::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.

Definition at line 294 of file DLS.h.

Referenced by Info(), and UpdateChunks().

String DLS::Info::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.

Definition at line 295 of file DLS.h.

Referenced by Info(), and UpdateChunks().

String DLS::Info::Technician

<ITCH-ck>. Identifies the technician who sampled the subject file.

Definition at line 296 of file DLS.h.

Referenced by Info(), and UpdateChunks().

String DLS::Info::Software

<ISFT-ck>. Identifies the name of the sofware package used to create the file.

Definition at line 297 of file DLS.h.

Referenced by Info(), and UpdateChunks().

String DLS::Info::Medium

<IMED-ck>. Describes the original subject of the file, such as, record, CD, and so forth.

Definition at line 298 of file DLS.h.

Referenced by Info(), and UpdateChunks().

String DLS::Info::Source

<ISRC-ck>. Identifies the name of the person or organization who supplied the original subject of the file.

Definition at line 299 of file DLS.h.

Referenced by Info(), and UpdateChunks().

String DLS::Info::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.

Definition at line 300 of file DLS.h.

Referenced by Info(), and UpdateChunks().

String DLS::Info::Commissioned

<ICMS-ck>. Lists the name of the person or organization that commissioned the subject of the file, e.g., Pope Julian II.

Definition at line 301 of file DLS.h.

Referenced by Info(), and UpdateChunks().

String DLS::Info::Subject

<ISBJ-ck>. Describes the contents of the file.

Definition at line 302 of file DLS.h.

Referenced by Info(), and UpdateChunks().

bool DLS::Info::UseFixedLengthStrings

Deprecated:
Not used anymore, use SetFixedStringLengths() instead.

Definition at line 303 of file DLS.h.


The documentation for this class was generated from the following files:
Generated on Sun May 1 03:22:46 2011 for libgig by  doxygen 1.5.2