CRI ADX  Last Updated: 2024-07-17 10:47 p
CriAtomMeter API

Data Structures

struct  CriAtomLevelMeterConfig
 Configuration structure for adding level meter function. More...
 
struct  CriAtomLevelInfoTag
 Level information. More...
 
struct  CriAtomLoudnessMeterConfig
 Configuration structure for adding the loudness meter functionThis is the configuration structure for adding the loudness meter function.
This structure is specified as an argument of the criAtomMeter_AttachLoudnessMeter function.
More...
 
struct  CriAtomLoudnessInfoTag
 Loudness information. More...
 
struct  CriAtomTruePeakMeterConfig
 Configuration structure for adding the true peak meter function.This is the configuration structure for adding the true peak meter function.
This structure is specified as an argument of the criAtomMeter_AttachTruePeakMeter function.
More...
 
struct  CriAtomTruePeakInfoTag
 True peak information. More...
 

Macros

#define criAtomMeter_SetDefaultConfigForLevelMeter(p_config)
 Sets default values for the level meter function configuration structure. More...
 

Typedefs

typedef struct CriAtomLevelInfoTag CriAtomLevelInfo
 Level information. More...
 
typedef struct CriAtomLoudnessInfoTag CriAtomLoudnessInfo
 Loudness information. More...
 
typedef struct CriAtomTruePeakInfoTag CriAtomTruePeakInfo
 True peak information. More...
 

Functions

CriSint32 criAtomMeter_CalculateWorkSizeForLevelMeter (const CriAtomLevelMeterConfig *config)
 Work size calculation for level meter function. More...
 
void criAtomMeter_AttachLevelMeter (const CriAtomLevelMeterConfig *config, void *work, CriSint32 work_size)
 Add level meter function. More...
 
void criAtomMeter_DetachLevelMeter (void)
 Remove level meter function. More...
 
void criAtomMeter_GetLevelInfo (CriAtomLevelInfo *info)
 Obtain level information. More...
 
CriSint32 criAtomMeter_CalculateWorkSizeForLoudnessMeter (const CriAtomLoudnessMeterConfig *config)
 Work size calculation for loudness meter function. More...
 
void criAtomMeter_AttachLoudnessMeter (const CriAtomLoudnessMeterConfig *config, void *work, CriSint32 work_size)
 Add loudness meter function. More...
 
void criAtomMeter_DetachLoudnessMeter (void)
 Remove loudness meter function. More...
 
void criAtomMeter_GetLoudnessInfo (CriAtomLoudnessInfo *info)
 Obtain loudness information. More...
 
void criAtomMeter_ResetLoudnessMeter (void)
 Reset loudness meter. More...
 
CriSint32 criAtomMeter_CalculateWorkSizeForTruePeakMeter (const CriAtomTruePeakMeterConfig *config)
 Work size calculation for true peak meter function. More...
 
void criAtomMeter_AttachTruePeakMeter (const CriAtomTruePeakMeterConfig *config, void *work, CriSint32 work_size)
 Add true peak meter function. More...
 
void criAtomMeter_DetachTruePeakMeter (void)
 Remove true peak meter function. More...
 
void criAtomMeter_GetTruePeakInfo (CriAtomTruePeakInfo *info)
 Obtain true peak information. More...
 
CriSint32 criAtomExAsrRack_CalculateWorkSizeForLevelMeter (CriAtomExAsrRackId rack_id, const CriAtomLevelMeterConfig *config)
 Work size calculation for ASR Rack specified level meter function. More...
 
void criAtomExAsrRack_AttachLevelMeter (CriAtomExAsrRackId rack_id, const CriAtomLevelMeterConfig *config, void *work, CriSint32 work_size)
 Added ASR Rack level meter function. More...
 
void criAtomExAsrRack_DetachLevelMeter (CriAtomExAsrRackId rack_id)
 Disable ASR Rack level meter function. More...
 
void criAtomExAsrRack_GetLevelInfo (CriAtomExAsrRackId rack_id, CriAtomLevelInfo *info)
 Get ASR Rack specification level information. More...
 
CriSint32 criAtomExAsrRack_CalculateWorkSizeForLoudnessMeter (CriAtomExAsrRackId rack_id, const CriAtomLoudnessMeterConfig *config)
 Calculation of work size for ASR Rack-specified loudness meter function. More...
 
void criAtomExAsrRack_AttachLoudnessMeter (CriAtomExAsrRackId rack_id, const CriAtomLoudnessMeterConfig *config, void *work, CriSint32 work_size)
 Added ASR Rack-specified loudness meter function. More...
 
void criAtomExAsrRack_DetachLoudnessMeter (CriAtomExAsrRackId rack_id)
 Disable the loudness meter function for the ASR rack. More...
 
void criAtomExAsrRack_GetLoudnessInfo (CriAtomExAsrRackId rack_id, CriAtomLoudnessInfo *info)
 Get ASR rack-specified loudness meter information. More...
 
void criAtomExAsrRack_ResetLoudnessMeter (CriAtomExAsrRackId rack_id)
 Reset the loudness meter specified for the ASR rack. More...
 
CriSint32 criAtomExAsrRack_CalculateWorkSizeForTruePeakMeter (CriAtomExAsrRackId rack_id, const CriAtomTruePeakMeterConfig *config)
 Calculates the work size for the ASR rack-specified true peak meter function. More...
 
void criAtomExAsrRack_AttachTruePeakMeter (CriAtomExAsrRackId rack_id, const CriAtomTruePeakMeterConfig *config, void *work, CriSint32 work_size)
 Adds true peak meter functionality for ASR racks. More...
 
void criAtomExAsrRack_DetachTruePeakMeter (CriAtomExAsrRackId rack_id)
 Disabling the ASR rack-specific true peak meter function. More...
 
void criAtomExAsrRack_GetTruePeakInfo (CriAtomExAsrRackId rack_id, CriAtomTruePeakInfo *info)
 Acquiring ASR rack-specific true peak information. More...
 

Detailed Description

Macro Definition Documentation

◆ criAtomMeter_SetDefaultConfigForLevelMeter

#define criAtomMeter_SetDefaultConfigForLevelMeter (   p_config)
Value:
{\
(p_config)->interval = 50;\
(p_config)->hold_time = 1000;\
}

Sets default values for the level meter function configuration structure.

Description:
Configuration structure set for the criAtomMeter_AttachLevelMeter function. Sets the default values for ( CriAtomLevelMeterConfig ).
See also
criAtomMeter_AttachLevelMeter, CriAtomLevelMeterConfig

Typedef Documentation

◆ CriAtomLevelInfo

Level information.

Description:
Structure for acquiring level information.
This is used in the criAtomMeter_GetLevelInfo function.
Remarks:
The unit used for level values is dB.
See also
criAtomMeter_GetLevelInfo

◆ CriAtomLoudnessInfo

Loudness information.

Description:
Structure for acquiring loudness information.
This is used in the criAtomMeter_GetLoudnessInfo function.
Remarks:
The unit used for level values is LKFS.
See also
criAtomMeter_GetLoudnessInfo

◆ CriAtomTruePeakInfo

True peak information.

Description:
Structure for acquiring true peak information.
This is used in the criAtomMeter_GetTruePeakInfo function.
Remarks:
The unit used for level values is dB.
See also
criAtomMeter_GetTruePeakInfo

Function Documentation

◆ criAtomMeter_CalculateWorkSizeForLevelMeter()

CriSint32 criAtomMeter_CalculateWorkSizeForLevelMeter ( const CriAtomLevelMeterConfig config)

Work size calculation for level meter function.

Parameters
[in]configConfiguration structure for adding the level meter
Returns
CriSint32 Required work area size
Description:
Calculates the work area size required for adding a level meter.
If NULL is specified for config, calculation will be performed with the default settings.
See also
criAtomMeter_AttachLevelMeter

◆ criAtomMeter_AttachLevelMeter()

void criAtomMeter_AttachLevelMeter ( const CriAtomLevelMeterConfig config,
void *  work,
CriSint32  work_size 
)

Add level meter function.

Parameters
[in]configConfiguration structure for adding the level meter
[in]workWork area
[in]work_sizeWork area size
Description:
Adds the level meter function to the library.
If NULL is specified for config, the level meter will be added with the default settings.
If NULL is specified for work and 0 is specified for work_size, the registered user allocator will be used to allocate the work area.
See also
criAtomMeter_GetLevelInfo

◆ criAtomMeter_DetachLevelMeter()

void criAtomMeter_DetachLevelMeter ( void  )

Remove level meter function.

Description:
Removes the level meter function from the library.
See also
criAtomMeter_AttachLevelMeter

◆ criAtomMeter_GetLevelInfo()

void criAtomMeter_GetLevelInfo ( CriAtomLevelInfo info)

Obtain level information.

Parameters
[out]infoLevel information structure
Description:
Acquires the level meter results.
The level meter function must be added in advance to the specified bus by using the criAtomMeter_AttachLevelMeter function.
See also
criAtomMeter_AttachLevelMeter

◆ criAtomMeter_CalculateWorkSizeForLoudnessMeter()

CriSint32 criAtomMeter_CalculateWorkSizeForLoudnessMeter ( const CriAtomLoudnessMeterConfig config)

Work size calculation for loudness meter function.

Parameters
[in]configConfiguration structure for adding the loudness meter
Returns
CriSint32 Required work area size
Description:
Calculates the work area size required for adding an ITU-R BS.1770-3 standard loudness meter.
If NULL is specified for config, calculation will be performed with the default settings.
See also
criAtomMeter_AttachLoudnessMeter

◆ criAtomMeter_AttachLoudnessMeter()

void criAtomMeter_AttachLoudnessMeter ( const CriAtomLoudnessMeterConfig config,
void *  work,
CriSint32  work_size 
)

Add loudness meter function.

Parameters
[in]configConfiguration structure for adding the loudness meter
[in]workWork area
[in]work_sizeWork area size
Description:
Adds the ITU-R BS.1770-3 standard loudness meter function to the library.
If NULL is specified for config, the loudness meter will be added with the default settings.
If NULL is specified for work and 0 is specified for work_size, the registered user allocator will be used to allocate the work area.
See also
criAtomMeter_GetLoudnessInfo

◆ criAtomMeter_DetachLoudnessMeter()

void criAtomMeter_DetachLoudnessMeter ( void  )

Remove loudness meter function.

Description:
Removes the loudness meter function from the library.
See also
criAtomMeter_AttachLoudnessMeter

◆ criAtomMeter_GetLoudnessInfo()

void criAtomMeter_GetLoudnessInfo ( CriAtomLoudnessInfo info)

Obtain loudness information.

Parameters
[out]infoLoudness information structure
Description:
Acquires the loudness meter measurement results. You must add a loudness meter to the library before calling this function.
See also
criAtomMeter_AttachLoudnessMeter

◆ criAtomMeter_ResetLoudnessMeter()

void criAtomMeter_ResetLoudnessMeter ( void  )

Reset loudness meter.

Description:
Resets the cumulative loudness meter data. You must add a loudness meter to the library before calling this function.
See also
criAtomMeter_AttachLoudnessMeter

◆ criAtomMeter_CalculateWorkSizeForTruePeakMeter()

CriSint32 criAtomMeter_CalculateWorkSizeForTruePeakMeter ( const CriAtomTruePeakMeterConfig config)

Work size calculation for true peak meter function.

Parameters
[in]configConfiguration structure for adding the true peak meter
Returns
CriSint32 Required work area size
Description:
Calculates the work area size required for adding an ITU-R BS.1770-3 standard true peak meter.
If NULL is specified for config, calculation will be performed with the default settings.
See also
criAtomMeter_AttachTruePeakMeter

◆ criAtomMeter_AttachTruePeakMeter()

void criAtomMeter_AttachTruePeakMeter ( const CriAtomTruePeakMeterConfig config,
void *  work,
CriSint32  work_size 
)

Add true peak meter function.

Parameters
[in]configConfiguration structure for adding the true peak meter
[in]workWork area
[in]work_sizeWork area size
Description:
Adds the ITU-R BS.1770-3 standard true peak meter function to the library.
If NULL is specified for config, the true peak meter will be added with the default settings.
If NULL is specified for work and 0 is specified for work_size, the registered user allocator will be used to allocate the work area.
See also
criAtomMeter_GetTruePeakInfo

◆ criAtomMeter_DetachTruePeakMeter()

void criAtomMeter_DetachTruePeakMeter ( void  )

Remove true peak meter function.

Description:
Removes the true peak meter function from the library.
See also
criAtomMeter_AttachLoudnessMeter

◆ criAtomMeter_GetTruePeakInfo()

void criAtomMeter_GetTruePeakInfo ( CriAtomTruePeakInfo info)

Obtain true peak information.

Parameters
[out]infoTrue peak information structure
Description:
Acquires the true peak meter measurement results. You must add a true peak meter to the library before calling this function.
See also
criAtomMeter_AttachTruePeakMeter

◆ criAtomExAsrRack_CalculateWorkSizeForLevelMeter()

CriSint32 criAtomExAsrRack_CalculateWorkSizeForLevelMeter ( CriAtomExAsrRackId  rack_id,
const CriAtomLevelMeterConfig config 
)

Work size calculation for ASR Rack specified level meter function.

Parameters
[in]rack_idASR Rack ID
[in]configConfiguration structure for adding a level meter
Returns
CriSint32 Required work area size
Description:
Calculates the work area size required to add a level meter to the ASR Rack specified by rack_id.
If config is set to NULL, it will be calculated using the default settings.
See also
criAtomExAsrRack_AttachLevelMeter

◆ criAtomExAsrRack_AttachLevelMeter()

void criAtomExAsrRack_AttachLevelMeter ( CriAtomExAsrRackId  rack_id,
const CriAtomLevelMeterConfig config,
void *  work,
CriSint32  work_size 
)

Added ASR Rack level meter function.

Parameters
[in]rack_idASR Rack ID
[in]configConfiguration structure for adding a level meter
[in]workWork area
[in]work_sizeWork area size
Description:
Adds a level meter function to the ASR Rack specified by rack_id.
If you specify NULL for config, a level meter will be added with the default settings.
If work is set to NULL and work_size is set to 0, the A work area is allocated.
See also
criAtomExAsrRack_GetLevelInfo

◆ criAtomExAsrRack_DetachLevelMeter()

void criAtomExAsrRack_DetachLevelMeter ( CriAtomExAsrRackId  rack_id)

Disable ASR Rack level meter function.

Parameters
[out]rack_idASR Rack ID
Description:
Cancels the level meter function added to the ASR Rack specified by rack_id.
See also
criAtomExAsrRack_AttachLevelMeter

◆ criAtomExAsrRack_GetLevelInfo()

void criAtomExAsrRack_GetLevelInfo ( CriAtomExAsrRackId  rack_id,
CriAtomLevelInfo info 
)

Get ASR Rack specification level information.

Parameters
[out]rack_idASR Rack ID
[out]infoLevel information structure
Description:
Gets the result of the level meter of the ASR Rack specified by rack_id.
The specified rack is set in advance by the criAtomExAsrRack_AttachLevelMeter function. The level meter function must be added.
See also
criAtomExAsrRack_AttachLevelMeter

◆ criAtomExAsrRack_CalculateWorkSizeForLoudnessMeter()

CriSint32 criAtomExAsrRack_CalculateWorkSizeForLoudnessMeter ( CriAtomExAsrRackId  rack_id,
const CriAtomLoudnessMeterConfig config 
)

Calculation of work size for ASR Rack-specified loudness meter function.

Parameters
[in]rack_idASR Rack ID
[in]configConfiguration structure for adding a loudness meter
Returns
CriSint32 Required work area size
Description:
Calculates the work area size required to add a loudness meter conforming to the ITU-R BS.1770-3 standard to the ASR Rack specified by rack_id.
If config is set to NULL, it will be calculated using the default settings.
See also
criAtomExAsrRack_AttachLoudnessMeter

◆ criAtomExAsrRack_AttachLoudnessMeter()

void criAtomExAsrRack_AttachLoudnessMeter ( CriAtomExAsrRackId  rack_id,
const CriAtomLoudnessMeterConfig config,
void *  work,
CriSint32  work_size 
)

Added ASR Rack-specified loudness meter function.

Parameters
[in]rack_idASR Rack ID
[in]configConfiguration structure for adding a loudness meter
[in]workWork area
[in]work_sizeWork area size
Description:
Adds the ITU-R BS.1770-3 standard loudness meter function to the ASR Rack specified by rack_id.
If you specify NULL for config, a loudness meter will be added with the default settings.
If work is set to NULL and work_size is set to 0, the work area will be allocated by the registered user allocator.
See also
criAtomExAsrRack_GetLoudnessInfo

◆ criAtomExAsrRack_DetachLoudnessMeter()

void criAtomExAsrRack_DetachLoudnessMeter ( CriAtomExAsrRackId  rack_id)

Disable the loudness meter function for the ASR rack.

Parameters
[in]rack_idASR rack ID
Description:
Disables the loudness meter function for the ASR rack specified by rack_id.
See also
criAtomExAsrRack_DetachLoudnessMeter

◆ criAtomExAsrRack_GetLoudnessInfo()

void criAtomExAsrRack_GetLoudnessInfo ( CriAtomExAsrRackId  rack_id,
CriAtomLoudnessInfo info 
)

Get ASR rack-specified loudness meter information.

Parameters
[in]rack_idASR rack ID
[out]infoLoudness information structure
Description:
Gets the loudness meter results for the ASR rack specified by rack_id.
The loudness meter function must be added to the specified rack beforehand using the criAtomExAsrRack_AttachLoudnessMeter function.
See also
criAtomExAsrRack_AttachLoudnessMeter

◆ criAtomExAsrRack_ResetLoudnessMeter()

void criAtomExAsrRack_ResetLoudnessMeter ( CriAtomExAsrRackId  rack_id)

Reset the loudness meter specified for the ASR rack.

Description:
Resets the accumulated data of the loudness meter for the ASR rack specified by rack_id. The loudness meter must be added to the library before calling this function.
See also
criAtomExAsrRack_AttachLoudnessMeter

◆ criAtomExAsrRack_CalculateWorkSizeForTruePeakMeter()

CriSint32 criAtomExAsrRack_CalculateWorkSizeForTruePeakMeter ( CriAtomExAsrRackId  rack_id,
const CriAtomTruePeakMeterConfig config 
)

Calculates the work size for the ASR rack-specified true peak meter function.

Parameters
[in]rack_idASR rack ID
[in]configConfiguration structure for adding a true peak meter
Returns
CriSint32 Required work area size
Description:
Calculates the work area size required to add an ITU-R BS.1770-3 standard true peak meter to the ASR rack specified by rack_id.
If config is specified as NULL, the calculation will be performed using the default settings.
See also
criAtomExAsrRack_AttachTruePeakMeter

◆ criAtomExAsrRack_AttachTruePeakMeter()

void criAtomExAsrRack_AttachTruePeakMeter ( CriAtomExAsrRackId  rack_id,
const CriAtomTruePeakMeterConfig config,
void *  work,
CriSint32  work_size 
)

Adds true peak meter functionality for ASR racks.

Parameters
[in]rack_idASR rack ID
[in]configConfiguration structure for adding true peak meter
[in]workWork area
[in]work_sizeWork area size
Description:
Adds true peak meter functionality conforming to the ITU-R BS.1770-3 standard to the ASR rack specified by rack_id.
If config is specified as NULL, a true peak meter will be added with default settings.
If work is specified as NULL and work_size is specified as 0, the work area will be allocated by the registered user allocator.
See also
criAtomExAsrRack_GetTruePeakInfo

◆ criAtomExAsrRack_DetachTruePeakMeter()

void criAtomExAsrRack_DetachTruePeakMeter ( CriAtomExAsrRackId  rack_id)

Disabling the ASR rack-specific true peak meter function.

Parameters
[in]rack_idASR rack ID
Description:
This command cancels the true peak meter function added to the ASR rack specified by rack_id.
See also
criAtomExAsrRack_AttachTruePeakMeter

◆ criAtomExAsrRack_GetTruePeakInfo()

void criAtomExAsrRack_GetTruePeakInfo ( CriAtomExAsrRackId  rack_id,
CriAtomTruePeakInfo info 
)

Acquiring ASR rack-specific true peak information.

Parameters
[in]rack_idASR rack ID
[out]infoTrue peak information structure
Description:
Gets the true peak meter measurement results for the ASR rack specified by rack_id. The true peak meter must be added to the library before calling this function.
See also
criAtomExAsrRack_AttachTruePeakMeter