mxm Namespace Reference

Namespace housing some modularMX generic stuff. More...


Classes

class  smart
 modularMX smart pointer implementation - please read Thread Safety note below. More...

Namespaces

namespace  JPEG
 Some JPEG-specific stuff.

Typedefs

typedef unsigned char u8
typedef unsigned short u16
typedef short s16
typedef unsigned int u32
typedef unsigned long long u64
typedef unsigned int flags
typedef u64 frame_time
 Time type used with MX frames, in microseconds since the epoch.

Enumerations

enum  EVideoFormat { eNoVideo = 0, eMxPEGVideo = 1, eMJPGVideo = 2, eUnknownVideo = 666 }
 Known video formats.
enum  EAudioFormat { eNoAudio = 0, ePCMAlaw8kHzAudio = 1, eUnknownAudio = 666 }
 Known audio formats.
enum  Direction { LeftToRightDirection, TopToBottomDirection }
enum  StatusMessageType {
  DesperateDebugMessage = 10, DebugMessage = 20, DebugWarningMessage = 30, StatusMessage = 40,
  ImportantStatusMessage = 45, SuccessMessage = 50, WarningMessage = 60, FailureMessage = 70,
  TerminalMessage = 80, NullMessage = 666
}
 Verbosity level of central status message facility.

Functions

int randomNumber (int max)
 Returns an integer random number from { 0, 1, 2, ..., max}.
void substituteArguments (mxmString &txt, const mxmStringList &args)
 Substitutes $n argument placeholders by the arguments they reference in the specified string list.
mxmString hex (void *mem_block, int block_size)
 Produces hexdump representation of the given memory block.
bool debugMode (void)
 Tells whether or not the modularMX debug mode is enabled.
void sendStatusMessage (mxm::StatusMessageType msg_type, const mxmString &message, const mxmObject *sending_object=0)
 [Callable anytime] Outputs a message via the central status message facility.
void addStatusMessageHandler (mxmStatusMessageHandlerInterface *msg_handler)
 [Not synchronized!] Installs a new custom status message handler.
void removeStatusMessageHandler (mxmStatusMessageHandlerInterface *msg_handler)
 [Not synchronized!] Uninstalls a given custom status message handler.
void removeStatusMessageHandlers ()
 [Not synchronized!] Uninstalls all custom status message handlers.
void setStatusMessageVerbosity (StatusMessageType msg_level)
 [Not synchronized!] Sets the verbosity level for the central status message facility.
bool statusMessageUseful (StatusMessageType msg_level)
 [Not synchronized!] Returns true if and only if there is currently interest in messages of the level specified.
mxmString rttiClassName (const mxmObject *sending_object)
 Returns the C++ implementation's runtime type information class name for the mxm object.
void terminal (const mxmString &msg, const mxmObject *sending_object=0)
 Called when terminal condition encountered - was introduced when we turned away from exceptions.
void convert_RGB_to_YUV (mxm::u8 r, mxm::u8 g, mxm::u8 b, mxm::u8 *y, mxm::u8 *u, mxm::u8 *v)
 Colorspace conversion from RGB to YUV.
void convert_RGB_to_YCbCr (mxm::u8 r, mxm::u8 g, mxm::u8 b, mxm::u8 *y, mxm::u8 *Cb, mxm::u8 *Cr)
 Colorspace conversion from RGB to YCbCr honoring ITU-R BT.601.
void clamp_s16 (s16 *numba, s16 min, s16 max)
 Does the obvious thing.
void clamp_int (int *numba, int min, int max)
 Does the obvious thing.
void clamp_float (float *numba, float min, float max)
 Does the obvious thing.
MXM_QT_API mxmString mxmStr (const QString &q_str)
 Conversion.
MXM_QT_API QString qStr (const mxmString &mxm_str)
 Conversion.
MXM_QT_API bool connect (const mxmQtSignal &source_signal, const mxmQtSlot &target_slot)
 For conveniently wiring up Qt signals.
MXM_QT_API bool connect (const mxmQtSignal &source_signal, const mxmQtSignal &target_signal)
 For conveniently wiring up Qt signals.
MXM_QT_API bool connect (const mxmQtSignal &source_signal, const QObject *receiver, const char *method)
 For conveniently wiring up Qt signals.
MXM_QT_API bool connect (const QObject *sender, const char *signal, const mxmQtSlot &target_slot)
 For conveniently wiring up Qt signals.
MXM_QT_API bool connect (const QObject *sender, const char *signal, const mxmQtSignal &target_signal)
 For conveniently wiring up Qt signals.
mxmString mxmStr (const QString &q_str)
 Conversion.
QString qStr (const mxmString &mxm_str)
 Conversion.
bool connect (const mxmQtSignal &source_signal, const mxmQtSlot &target_slot)
 For conveniently wiring up Qt signals.
bool connect (const mxmQtSignal &source_signal, const mxmQtSignal &target_signal)
 For conveniently wiring up Qt signals.
bool connect (const mxmQtSignal &source_signal, const QObject *receiver, const char *method)
 For conveniently wiring up Qt signals.
bool connect (const QObject *sender, const char *signal, const mxmQtSlot &target_slot)
 For conveniently wiring up Qt signals.
bool connect (const QObject *sender, const char *signal, const mxmQtSignal &target_signal)
 For conveniently wiring up Qt signals.

Variables

const int DialogSpacing = 10
const int StatusMessageHandlerSlots = 10
MXM_CORE_API const char * ValidFilenameCharacters
MXM_CORE_API const char * WhitespaceCharacters = " \t\r"
MXM_CORE_API mxmStatusMessageHandlerInterfaceStatusMessageHandlers [StatusMessageHandlerSlots+1] = { 0 }
MXM_CORE_API StatusMessageType DefaultStatusMessageLevel = mxm::StatusMessage


Detailed Description

Namespace housing some modularMX generic stuff.

Function Documentation

MXM_CORE_API void mxm::addStatusMessageHandler mxmStatusMessageHandlerInterface msg_handler  ) 
 

[Not synchronized!] Installs a new custom status message handler.

The central status message facility assumes ownership over the handler.

MXM_CORE_API void mxm::removeStatusMessageHandler mxmStatusMessageHandlerInterface msg_handler  ) 
 

[Not synchronized!] Uninstalls a given custom status message handler.

The handler gets deleted.

If the specified handler is not installed, the method does nothing.

MXM_CORE_API void mxm::removeStatusMessageHandlers  ) 
 

[Not synchronized!] Uninstalls all custom status message handlers.

The handlers get deleted.

MXM_CORE_API void mxm::substituteArguments mxmString txt,
const mxmStringList args
 

Substitutes $n argument placeholders by the arguments they reference in the specified string list.

Parameters:
txt Text containing argument placeholders of the form $n where n is whole number.
args List of strings providing the arguments for substitution of the aforementioned $n placeholders.
Argument substitution is safe, that is, missing agruments in the list will not crash the application - an "[?]" is substituted instead. You are furthermore entirely free to change the sequential ordering of argument placeholders in the text string - the proper argument in the argument list is addressed via the whole number n in the respective $n placeholder.


Variable Documentation

const char * mxm::ValidFilenameCharacters
 

Initial value:

 "abcdefghijklmnopqrstuvwxyz"
                                           "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
                                           "1234567890"
                                           "_-."


Generated on Fri Jun 29 17:21:07 2007 for MxPEG SDK by  doxygen 1.4.6