drumstick 2.9.0
C++ MIDI libraries using Qt objects, idioms, and style.
Signals | Public Member Functions | List of all members
Rmidi Class Reference
MIDI File Formats » RIFF MIDI File Parser (Input)

RIFF MIDI file format (input only) More...

#include <rmid.h>

Inheritance diagram for Rmidi:
Inheritance graph
[legend]

Signals

void signalRiffInfo (const QString &infoType, const QByteArray &info)
 signalRMidInfo is emitted for each RIFF INFO element More...
 
void signalRiffData (const QString &dataType, const QByteArray &data)
 signalRiffData is emitted for each RMID data element More...
 

Public Member Functions

 Rmidi (QObject *parent=nullptr)
 Constructor. More...
 
virtual ~Rmidi ()
 Destructor.
 
void readFromFile (QString fileName)
 Reads a stream from a disk file. More...
 
void readFromStream (QDataStream *ds)
 Reads a stream. More...
 

Detailed Description

RIFF MIDI file format (input only)

This class is used to parse RIFF MIDI Files

Since
2.4.0
Examples
dumprmi.cpp, and guiplayer.cpp.

Definition at line 56 of file rmid.h.

Constructor & Destructor Documentation

◆ Rmidi()

Rmidi ( QObject *  parent = nullptr)
explicit

Constructor.

Parameters
parentObject owner

Definition at line 68 of file rmid.cpp.

Member Function Documentation

◆ readFromFile()

void readFromFile ( QString  fileName)

Reads a stream from a disk file.

Parameters
fileNameName of an existing file.

Definition at line 82 of file rmid.cpp.

References Rmidi::readFromStream().

◆ readFromStream()

void readFromStream ( QDataStream *  ds)

Reads a stream.

Parameters
dsPointer to an existing and opened input stream

Definition at line 96 of file rmid.cpp.

Referenced by Rmidi::readFromFile().

◆ signalRiffData

void signalRiffData ( const QString &  dataType,
const QByteArray &  data 
)
signal

signalRiffData is emitted for each RMID data element

The handler of this event should use the method QSmf::readFromStream() to parse the contents of the SMF data element.

Parameters
dataTypemay be "RMID" (SMF) or "DLS"
databinary payload, in RMID files is either a Standard MIDI File or a DLS structure

◆ signalRiffInfo

void signalRiffInfo ( const QString &  infoType,
const QByteArray &  info 
)
signal

signalRMidInfo is emitted for each RIFF INFO element

Parameters
infoTypeType of data (chunk ID) as defined in the spec (Source: www.midi.org rp29spec.pdf).
  • IARL Archival Location. Indicates where the subject of the file is archived.
  • IART Artist. Lists the artist (author) of the original subject of the file. For example: Les Getalong.
  • ICMS Commissioned. Lists the name of the person or organization that commissioned the subject of the file. For example: Acme Consolidated GameWorks.
  • ICMT Comments. Provides general comments about the file or the subject of the file. If the comment is several sentences long, end each sentence with a period. Do not include newline characters.
  • ICOP Copyright. Records the copyright information for the file. For example: Copyright Acme Consolidated GameWorks 1991. If there are multiple copyrights, separate them by a semicolon followed by a space.
  • ICRD Creation date. Specifies the date the subject of the file was created. List dates in year-month-day format, padding one-digit months and days with a zero on the left. For example: 1553-05-03 for May 3, 1553. The year should always be given using four digits.
  • IENG Engineer. Stores the name of the engineer who worked on the file. If there are multiple engineers, separate the names by a semicolon and a blank. For example: Smith, John; Adams, Joe.
  • IGNR Genre. Describes the original work, such as jazz, classical, rock, techno, rave, neo british pop grunge metal, etc.
  • IKEY Keywords. Provides a list of keywords that refer to the file or subject of the file. Separate multiple keywords with a semicolon and a blank. For example: FX; visitation; space alien.
  • IMED Medium. Describes the original subject of the file, such as record, CD and so forth.
  • INAM Name. Stores the title of the subject of the file, such as Seattle From Above.
  • IPRD Product. Specifies the name of the title the file was originally intended for, such as Galactic Ambassadors V.
  • ISBJ Subject. Describes the contents of the file, such as Music of the Gnu Whirled Order.
  • ISFT Software. Identifies the name of the software package used to create the file, such as Crash Compactor, Acme Consolidated Sonic Booms.
  • ISRC Source. Identifies the name of the person or organization who supplied the original subject of the file. For example: Acme Hysterical Media Archives.
  • ISRF Source Form. Identifies the original form of the material that was digitized, such as record, sampling CD, TV sound track and so forth. This is not necessarily the same as IMED.
  • ITCH Technician. Identifies the technician who sampled the subject file. For example: Smith, John.
Parameters
infoText data
The documentation for this class was generated from the following files: