AAX SDK  2.4.1
Avid Audio Extensions Development Kit
AAX_StringUtilities.h
Go to the documentation of this file.
1 /*================================================================================================*/
2 /*
3  *
4  * Copyright 2014-2016, 2018 by Avid Technology, Inc.
5  * All rights reserved.
6 
7  * CONFIDENTIAL: This document contains confidential information. Do not
8  * read or examine this document unless you are an Avid Technology employee
9  * or have signed a non-disclosure agreement with Avid Technology which protects
10  * the confidentiality of this document. DO NOT DISCLOSE ANY INFORMATION
11  * CONTAINED IN THIS DOCUMENT TO ANY THIRD-PARTY WITHOUT THE PRIOR WRITTEN CONSENT
12  * OF Avid Technology, INC.
13  */
14 
20 /*================================================================================================*/
21 #pragma once
22 
23 #ifndef AAXLibrary_AAX_StringUtilities_h
24 #define AAXLibrary_AAX_StringUtilities_h
25 
26 // AAX headers
27 #include "AAX.h"
28 #include "AAX_Enums.h"
29 
30 // Standard Library headers
31 #include <string>
32 
33 class AAX_IString;
34 
35 
36 //------------------------------------------------
37 #pragma mark Utility functions
38 
39 namespace AAX
40 {
41  inline void GetCStringOfLength(char *stringOut, const char* stringIn, int32_t aMaxChars);
42  inline int32_t Caseless_strcmp(const char* cs, const char* ct);
43 
44  inline std::string Binary2String(uint32_t binaryValue, int32_t numBits);
45  inline uint32_t String2Binary(const AAX_IString& s);
46 
47  inline bool IsASCII(char inChar);
48  inline bool IsFourCharASCII(uint32_t inFourChar);
49 
50  inline std::string AsStringFourChar(uint32_t inFourChar);
51  inline std::string AsStringPropertyValue(AAX_EProperty inProperty, AAX_CPropertyValue inPropertyValue);
52  inline std::string AsStringInt32(int32_t inInt32);
53  inline std::string AsStringUInt32(uint32_t inUInt32);
54  inline std::string AsStringIDTriad(const AAX_SPlugInIdentifierTriad& inIDTriad);
55  inline std::string AsStringStemFormat(AAX_EStemFormat inStemFormat, bool inAbbreviate = false);
56  inline std::string AsStringStemChannel(AAX_EStemFormat inStemFormat, uint32_t inChannelIndex, bool inAbbreviate);
57  inline std::string AsStringResult(AAX_Result inResult);
58 } // namespace AAX
59 
60 
61 //------------------------------------------------------
62 #pragma mark Implementation header
63 
64 #include "AAX_StringUtilities.hpp"
65 
66 
67 #endif /* AAXLibrary_AAX_StringUtilities_h */
Various utility definitions for AAX.
int32_t AAX_Result
Definition: AAX.h:337
int32_t AAX_CPropertyValue
32-bit property values
Definition: AAX.h:338
Utility functions for byte-swapping. Used by AAX_CChunkDataParser.
AAX_EStemFormat
Stem format definitions.
Definition: AAX_Enums.h:232
AAX_EProperty
The list of properties that can be added to an AAX_IPropertyMap.
Definition: AAX_Properties.h:72
Definition: AAX_Exception.h:42
bool IsFourCharASCII(uint32_t inFourChar)
Definition: AAX_StringUtilities.hpp:223
std::string AsStringPropertyValue(AAX_EProperty inProperty, AAX_CPropertyValue inPropertyValue)
Definition: AAX_StringUtilities.hpp:253
std::string AsStringFourChar(uint32_t inFourChar)
Definition: AAX_StringUtilities.hpp:238
std::string AsStringStemFormat(AAX_EStemFormat inStemFormat, bool inAbbreviate=false)
Definition: AAX_StringUtilities.hpp:322
std::string AsStringResult(AAX_Result inResult)
Definition: AAX_StringUtilities.hpp:536
int32_t Caseless_strcmp(const char *cs, const char *ct)
Definition: AAX_StringUtilities.hpp:131
std::string Binary2String(uint32_t binaryValue, int32_t numBits)
Definition: AAX_StringUtilities.hpp:174
uint32_t String2Binary(const AAX_IString &s)
Definition: AAX_StringUtilities.hpp:195
std::string AsStringIDTriad(const AAX_SPlugInIdentifierTriad &inIDTriad)
Definition: AAX_StringUtilities.hpp:310
void GetCStringOfLength(char *stringOut, const char *stringIn, int32_t aMaxChars)
==============================================================
Definition: AAX_StringUtilities.hpp:91
bool IsASCII(char inChar)
Definition: AAX_StringUtilities.hpp:218
std::string AsStringInt32(int32_t inInt32)
Definition: AAX_StringUtilities.hpp:294
std::string AsStringUInt32(uint32_t inUInt32)
Definition: AAX_StringUtilities.hpp:302
std::string AsStringStemChannel(AAX_EStemFormat inStemFormat, uint32_t inChannelIndex, bool inAbbreviate)
Definition: AAX_StringUtilities.hpp:358
Plug-in Identifier Triad.
Definition: AAX.h:554
A simple string container that can be passed across a binary boundary. This class,...
Definition: AAX_IString.h:41