Event representing a SMF text event. More...

#include <alsaevent.h>

Inheritance diagram for TextEvent:

[legend]

Public Member Functions
	TextEvent ()
	Default constructor.

	TextEvent (const snd_seq_event_t *event)
	Constructor from an ALSA sequencer record. More...

	TextEvent (const QString &text, const int textType=1)
	Constructor from a given string. More...

	TextEvent (const TextEvent &other)
	Copy constructor. More...

	TextEvent (const unsigned int datalen, char *dataptr)
	Constructor from a data pointer and length. More...

TextEvent &	operator= (const TextEvent &other)
	Assignment operator. More...

QString	getText () const
	Gets the event's text content. More...

int	getTextType () const
	Gets the event's SMF text type. More...

virtual TextEvent *	clone () const override
	Clone this object returning a pointer to the new object. More...

unsigned int	getLength () const
	Gets the data length. More...

const char *	getData () const
	Gets the data pointer. More...

void	setSequencerType (const snd_seq_event_type_t eventType)
	Sets the event's ALSA sequencer type. More...

snd_seq_event_type_t	getSequencerType () const
	Gets the sequencer event type. More...

void	setDestination (const unsigned char client, const unsigned char port)
	Sets the client:port destination of the event. More...

void	setSource (const unsigned char port)
	Sets the event's source port ID. More...

unsigned char	getSourceClient () const
	Gets the source client id. More...

unsigned char	getSourcePort () const
	Gets the source port id. More...

snd_seq_tick_time_t	getTick () const
	Gets the tick time of the event. More...

unsigned int	getRealTimeSecs () const
	Gets the seconds of the event's real time. More...

unsigned int	getRealTimeNanos () const
	Gets the nanoseconds of the event's real time. More...

void	setSubscribers ()
	Sets the event's destination to be all the subscribers of the source port.

void	setBroadcast ()
	Sets the event's destination to be all queues/clients/ports/channels.

void	setDirect ()
	Sets the event to be immediately delivered, not queued/scheduled. More...

void	scheduleTick (const int queue, const int tick, const bool relative)
	Sets the event to be scheduled in musical time (ticks) units. More...

void	scheduleReal (const int queue, const ulong secs, const ulong nanos, const bool relative)
	Sets the event to be scheduled in real (clock) time units. More...

void	setPriority (const bool high)
	Sets the priority of the event. More...

unsigned char	getTag () const
	Gets the tag of the event. More...

void	setTag (const unsigned char aTag)
	Sets the event's tag. More...

unsigned int	getRaw32 (const unsigned int n) const
	Gets an event's raw 32 bits parameter. More...

void	setRaw32 (const unsigned int n, const unsigned int value)
	Sets an event's raw 32 bits parameter. More...

unsigned char	getRaw8 (const unsigned int n) const
	Gets an event's raw 8 bits parameter. More...

void	setRaw8 (const unsigned int n, const unsigned char value)
	Sets an event's raw 8 bits parameter. More...

snd_seq_event_t *	getHandle ()
	Gets the handle of the event. More...

int	getEncodedLength ()
	Gets the encoded length of the event record. More...

Static Public Member Functions
static bool	isSubscription (const SequencerEvent *event)
	Checks if the event's type is a subscription. More...

static bool	isPort (const SequencerEvent *event)
	Checks if the event's type is of type port. More...

static bool	isClient (const SequencerEvent *event)
	Checks if the event's type is of type client. More...

static bool	isConnectionChange (const SequencerEvent *event)
	Checks if the event's type is of type connection change. More...

static bool	isChannel (const SequencerEvent *event)
	Checks if the event's type is a Channel Voice message. More...

Protected Member Functions
Q_DECL_DEPRECATED void	free ()
	Releases the event record. More...

Protected Attributes
snd_seq_event_t	m_event
	ALSA sequencer event record. More...

Detailed Description

Event representing a SMF text event.

This event type is not intended to be transmitted over the wire to an external device, but it is useful for sequencer programs or MIDI applications

Definition at line 503 of file alsaevent.h.

Constructor & Destructor Documentation

◆ TextEvent() [1/4]

TextEvent ( const snd_seq_event_t * event )

explicit

Constructor from an ALSA sequencer record.

Parameters

event ALSA sequencer record.

Definition at line 733 of file alsaevent.cpp.

References SequencerEvent::setSequencerType().

◆ TextEvent() [2/4]

TextEvent	(	const QString &	text,
		const int	textType = `1`
	)

explicit

Constructor from a given string.

Parameters

text	The event's text
textType	The SMF text type

Definition at line 744 of file alsaevent.cpp.

References SequencerEvent::setSequencerType().

◆ TextEvent() [3/4]

TextEvent ( const TextEvent & other )

Copy constructor.

Parameters

other An existing TextEvent object reference

Definition at line 754 of file alsaevent.cpp.

References TextEvent::getTextType(), and SequencerEvent::setSequencerType().

◆ TextEvent() [4/4]

TextEvent	(	const unsigned int	datalen,
		char *	dataptr
	)

Constructor from a data pointer and length.

Parameters

datalen	Data length
dataptr	Data pointer

Definition at line 766 of file alsaevent.cpp.

References SequencerEvent::setSequencerType().

Member Function Documentation

◆ clone()

TextEvent * clone ( ) const

overridevirtual

Clone this object returning a pointer to the new object.

Returns: pointer to the new object

Reimplemented from VariableEvent.

Definition at line 794 of file alsaevent.cpp.

References SequencerEvent::m_event, and TextEvent::TextEvent().

◆ free()

void free ( )

protectedinherited

Releases the event record.

Deprecated:: the event record is not allocated, so you don't have to call this function

Definition at line 371 of file alsaevent.cpp.

References SequencerEvent::m_event.

◆ getData()

const char * getData ( ) const

inlineinherited

Gets the data pointer.

Returns: the data pointer

Examples: dumpmid.cpp.

Definition at line 476 of file alsaevent.h.

◆ getEncodedLength()

int getEncodedLength ( )

inherited

Gets the encoded length of the event record.

Returns: The encoded length.

Definition at line 380 of file alsaevent.cpp.

References SequencerEvent::m_event.

◆ getHandle()

snd_seq_event_t * getHandle ( )

inlineinherited

Gets the handle of the event.

Returns: The event's handle

Definition at line 135 of file alsaevent.h.

Referenced by MidiClient::output(), MidiClient::outputBuffer(), MidiClient::outputDirect(), SequencerOutputThread::sendSongEvent(), MidiQueue::setRealTimePosition(), and MidiQueue::setTickPosition().

◆ getLength()

unsigned int getLength ( ) const

inlineinherited

Gets the data length.

Returns: the data length

Examples: dumpmid.cpp.

Definition at line 471 of file alsaevent.h.

◆ getRaw32()

unsigned int getRaw32 ( const unsigned int n ) const

inherited

Gets an event's raw 32 bits parameter.

Parameters

n	The parameter index, between 0 and 2.

Returns: The parameter's value.

See also: setRaw32()

Definition at line 329 of file alsaevent.cpp.

References SequencerEvent::m_event.

◆ getRaw8()

unsigned char getRaw8 ( const unsigned int n ) const

inherited

Gets an event's raw 8 bits parameter.

Parameters

n	The parameter index, between 0 and 11.

Returns: The parameter's value.

See also: setRaw8()

Definition at line 351 of file alsaevent.cpp.

References SequencerEvent::m_event.

◆ getRealTimeNanos()

unsigned int getRealTimeNanos ( ) const

inlineinherited

Gets the nanoseconds of the event's real time.

Returns: The nanoseconds of the time.

See also: scheduleReal(), getRealTimeSecs()

Definition at line 113 of file alsaevent.h.

◆ getRealTimeSecs()

unsigned int getRealTimeSecs ( ) const

inlineinherited

Gets the seconds of the event's real time.

Returns: The seconds of the time.

See also: scheduleReal(), getRealTimeNanos()

Definition at line 107 of file alsaevent.h.

◆ getSequencerType()

snd_seq_event_type_t getSequencerType ( ) const

inlineinherited

Gets the sequencer event type.

Returns: The sequencer event type.

See also: setSequencerType()

Examples: drumgrid.cpp, dumpmid.cpp, and metronome.cpp.

Definition at line 81 of file alsaevent.h.

◆ getSourceClient()

unsigned char getSourceClient ( ) const

inlineinherited

Gets the source client id.

Returns: The source client id.

See also: setSource()

Examples: dumpmid.cpp.

Definition at line 89 of file alsaevent.h.

◆ getSourcePort()

unsigned char getSourcePort ( ) const

inlineinherited

Gets the source port id.

Returns: The source port id.

See also: setSource()

Examples: dumpmid.cpp.

Definition at line 95 of file alsaevent.h.

◆ getTag()

unsigned char getTag ( ) const

inlineinherited

Gets the tag of the event.

Returns: The event's tag

See also: setTag()

Definition at line 125 of file alsaevent.h.

◆ getText()

QString getText ( ) const

Gets the event's text content.

Returns: The text content.

Definition at line 776 of file alsaevent.cpp.

◆ getTextType()

int getTextType ( ) const

Gets the event's SMF text type.

Returns: The SMF text type.

Definition at line 785 of file alsaevent.cpp.

Referenced by TextEvent::operator=(), and TextEvent::TextEvent().

◆ getTick()

snd_seq_tick_time_t getTick ( ) const

inlineinherited

Gets the tick time of the event.

Returns: The tick time.

See also: scheduleTick()

Examples: drumgrid.cpp, dumpmid.cpp, and metronome.cpp.

Definition at line 101 of file alsaevent.h.

◆ isChannel()

bool isChannel ( const SequencerEvent * event )

staticinherited

Checks if the event's type is a Channel Voice message.

Parameters

event A SequencerEvent object pointer

Returns: True if the event is a channel voice message.

Since: 0.2.0

Definition at line 203 of file alsaevent.cpp.

◆ isClient()

bool isClient ( const SequencerEvent * event )

staticinherited

Checks if the event's type is of type client.

Parameters

event A SequencerEvent object pointer

Returns: True if the event has a client start/exit/change type.

Definition at line 169 of file alsaevent.cpp.

◆ isConnectionChange()

bool isConnectionChange ( const SequencerEvent * event )

staticinherited

Checks if the event's type is of type connection change.

Parameters

event A SequencerEvent object pointer

Returns: True if the event has a client/port/subscription type.

Definition at line 183 of file alsaevent.cpp.

Referenced by SequencerOutputThread::run().

◆ isPort()

bool isPort ( const SequencerEvent * event )

staticinherited

Checks if the event's type is of type port.

Parameters

event A SequencerEvent object pointer

Returns: True if the event has a port start/exit/change type.

Definition at line 155 of file alsaevent.cpp.

◆ isSubscription()

bool isSubscription ( const SequencerEvent * event )

staticinherited

Checks if the event's type is a subscription.

Parameters

event A SequencerEvent object pointer

Returns: True if the event has a subscribe/unsubscribe type.

Definition at line 142 of file alsaevent.cpp.

◆ operator=()

TextEvent & operator= ( const TextEvent & other )

Assignment operator.

Parameters

other Another TextEvent object reference

Returns: pointer to this object

Definition at line 804 of file alsaevent.cpp.

References TextEvent::getTextType(), SequencerEvent::m_event, and SequencerEvent::setSequencerType().

◆ scheduleReal()

void scheduleReal	(	const int	queue,
		const ulong	secs,
		const ulong	nanos,
		const bool	relative
	)

inherited

Sets the event to be scheduled in real (clock) time units.

Parameters

queue	The queue number to be used.
secs	The time in whole seconds.
nanos	The nanoseconds to be added.
relative	Use relative (to the current) time instead of absolute time.

Definition at line 290 of file alsaevent.cpp.

References SequencerEvent::m_event.