| AAX SDK 2.6.1 Avid Audio Extensions Development Kit

- Welcome
- Manual
- Classes
- Files
- Lists
- Support

- File List
- File Members

Loading...
Searching...
No Matches
AAX_StringUtilities.h
Go to the documentation of this file.
1/*================================================================================================*/
2/*
3 *
4 * Copyright 2014-2016, 2018, 2023 Avid Technology, Inc.
5 * All rights reserved.
6 *
7 * CONFIDENTIAL: this document contains confidential information of Avid. Do
8 * not disclose to any third party. Use of the information contained in this
9 * document is subject to an Avid SDK license.
10 */
11
17/*================================================================================================*/
18#pragma once
19
20#ifndef AAXLibrary_AAX_StringUtilities_h
21#define AAXLibrary_AAX_StringUtilities_h
22
23// AAX headers
24#include "AAX.h"
25#include "AAX_Enums.h"
26
27// Standard Library headers
28#include <string>
29
30 class AAX_IString;
31
32
33//------------------------------------------------
34#pragma mark Utility functions
35
36 namespace AAX
37{
38 inline void GetCStringOfLength(char *stringOut, const char* stringIn, int32_t aMaxChars);
39 inline int32_t Caseless_strcmp(const char* cs, const char* ct);
40
41 inline std::string Binary2String(uint32_t binaryValue, int32_t numBits);
42 inline uint32_t String2Binary(const AAX_IString& s);
43
44 inline bool IsASCII(char inChar);
45 inline bool IsFourCharASCII(uint32_t inFourChar);
46
47 inline std::string AsStringFourChar(uint32_t inFourChar);
48 inline std::string AsStringPropertyValue(AAX_EProperty inProperty, AAX_CPropertyValue inPropertyValue);
49 inline std::string AsStringInt32(int32_t inInt32);
50 inline std::string AsStringUInt32(uint32_t inUInt32);
51 inline std::string AsStringIDTriad(const AAX_SPlugInIdentifierTriad& inIDTriad);
52 inline std::string AsStringStemFormat(AAX_EStemFormat inStemFormat, bool inAbbreviate = false);
53 inline std::string AsStringStemChannel(AAX_EStemFormat inStemFormat, uint32_t inChannelIndex, bool inAbbreviate);
54 inline std::string AsStringResult(AAX_Result inResult);
55} // namespace AAX
56
57
58//------------------------------------------------------
59#pragma mark Implementation header
60
61#include "AAX_StringUtilities.hpp"
62
63
64#endif /* AAXLibrary_AAX_StringUtilities_h */
AAX_Enums.h
Utility functions for byte-swapping. Used by AAX_CChunkDataParser.
AAX_EStemFormat
AAX_EStemFormat
Stem format definitions.
Definition: AAX_Enums.h:230
AAX.h
Various utility definitions for AAX.
AAX_Result
int32_t AAX_Result
Definition: AAX.h:334
AAX_CPropertyValue
int32_t AAX_CPropertyValue
32-bit property values
Definition: AAX.h:335
AAX_StringUtilities.hpp
AAX_EProperty
AAX_EProperty
The list of properties that can be added to an AAX_IPropertyMap.
Definition: AAX_Properties.h:69
AAX
Definition: AAX_EnvironmentUtilities.h:59
AAX::IsFourCharASCII
bool IsFourCharASCII(uint32_t inFourChar)
Definition: AAX_StringUtilities.hpp:222
AAX::AsStringPropertyValue
std::string AsStringPropertyValue(AAX_EProperty inProperty, AAX_CPropertyValue inPropertyValue)
Definition: AAX_StringUtilities.hpp:294
AAX::AsStringFourChar
std::string AsStringFourChar(uint32_t inFourChar)
Definition: AAX_StringUtilities.hpp:237
AAX::AsStringStemFormat
std::string AsStringStemFormat(AAX_EStemFormat inStemFormat, bool inAbbreviate=false)
Definition: AAX_StringUtilities.hpp:349
AAX::AsStringResult
std::string AsStringResult(AAX_Result inResult)
Definition: AAX_StringUtilities.hpp:773
AAX::Caseless_strcmp
int32_t Caseless_strcmp(const char *cs, const char *ct)
Definition: AAX_StringUtilities.hpp:130
AAX::Binary2String
std::string Binary2String(uint32_t binaryValue, int32_t numBits)
Definition: AAX_StringUtilities.hpp:173
AAX::String2Binary
uint32_t String2Binary(const AAX_IString &s)
Definition: AAX_StringUtilities.hpp:194
AAX::AsStringIDTriad
std::string AsStringIDTriad(const AAX_SPlugInIdentifierTriad &inIDTriad)
Definition: AAX_StringUtilities.hpp:337
AAX::GetCStringOfLength
void GetCStringOfLength(char *stringOut, const char *stringIn, int32_t aMaxChars)
==============================================================
Definition: AAX_StringUtilities.hpp:90
AAX::IsASCII
bool IsASCII(char inChar)
Definition: AAX_StringUtilities.hpp:217
AAX::AsStringInt32
std::string AsStringInt32(int32_t inInt32)
Definition: AAX_StringUtilities.hpp:327
AAX::AsStringUInt32
std::string AsStringUInt32(uint32_t inUInt32)
Definition: AAX_StringUtilities.hpp:332
AAX::AsStringStemChannel
std::string AsStringStemChannel(AAX_EStemFormat inStemFormat, uint32_t inChannelIndex, bool inAbbreviate)
Definition: AAX_StringUtilities.hpp:398
AAX_SPlugInIdentifierTriad
Plug-in Identifier Triad.
Definition: AAX.h:553
AAX_IString
A simple string container that can be passed across a binary boundary. This class,...
Definition: AAX_IString.h:38