| AAX SDK 2.8.0 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-2024 Avid Technology, Inc.
5 * All rights reserved.
6 *
7 * This file is part of the Avid AAX SDK.
8 *
9 * The AAX SDK is subject to commercial or open-source licensing.
10 *
11 * By using the AAX SDK, you agree to the terms of both the Avid AAX SDK License
12 * Agreement and Avid Privacy Policy.
13 *
14 * AAX SDK License: https://developer.avid.com/aax
15 * Privacy Policy: https://www.avid.com/legal/privacy-policy-statement
16 *
17 * Or: You may also use this code under the terms of the GPL v3 (see
18 * www.gnu.org/licenses).
19 *
20 * THE AAX SDK IS PROVIDED "AS IS" WITHOUT ANY WARRANTY, AND ALL WARRANTIES, WHETHER
21 * EXPRESSED OR IMPLIED, INCLUDING MERCHANTABILITY AND FITNESS FOR PURPOSE, ARE
22 * DISCLAIMED.
23 */
24
30/*================================================================================================*/
31#pragma once
32
33#ifndef AAXLibrary_AAX_StringUtilities_h
34#define AAXLibrary_AAX_StringUtilities_h
35
36// AAX headers
37#include "AAX.h"
38#include "AAX_Enums.h"
39
40// Standard Library headers
41#include <string>
42
43 class AAX_IString;
44
45
46//------------------------------------------------
47#pragma mark Utility functions
48
49 namespace AAX
50{
51 inline void GetCStringOfLength(char *stringOut, const char* stringIn, int32_t aMaxChars);
52 inline int32_t Caseless_strcmp(const char* cs, const char* ct);
53
54 inline std::string Binary2String(uint32_t binaryValue, int32_t numBits);
55 inline uint32_t String2Binary(const AAX_IString& s);
56
57 inline bool IsASCII(char inChar);
58 inline bool IsFourCharASCII(uint32_t inFourChar);
59
60 inline std::string AsStringFourChar(uint32_t inFourChar);
61 inline std::string AsStringPropertyValue(AAX_EProperty inProperty, AAX_CPropertyValue inPropertyValue);
62 inline std::string AsStringInt32(int32_t inInt32);
63 inline std::string AsStringUInt32(uint32_t inUInt32);
64 inline std::string AsStringIDTriad(const AAX_SPlugInIdentifierTriad& inIDTriad);
65 inline std::string AsStringStemFormat(AAX_EStemFormat inStemFormat, bool inAbbreviate = false);
66 inline std::string AsStringStemChannel(AAX_EStemFormat inStemFormat, uint32_t inChannelIndex, bool inAbbreviate);
67 inline std::string AsStringResult(AAX_Result inResult);
68 inline std::string AsStringSupportLevel(AAX_ESupportLevel inSupportLevel);
69} // namespace AAX
70
71
72//------------------------------------------------------
73#pragma mark Implementation header
74
75#include "AAX_StringUtilities.hpp"
76
77
78#endif /* AAXLibrary_AAX_StringUtilities_h */
AAX_Enums.h
Utility functions for byte-swapping. Used by AAX_CChunkDataParser.
AAX_ESupportLevel
AAX_ESupportLevel
Definition: AAX_Enums.h:1320
AAX_EStemFormat
AAX_EStemFormat
Stem format definitions.
Definition: AAX_Enums.h:243
AAX.h
Various utility definitions for AAX.
AAX_Result
int32_t AAX_Result
Definition: AAX.h:347
AAX_CPropertyValue
int32_t AAX_CPropertyValue
32-bit property values
Definition: AAX.h:348
AAX_StringUtilities.hpp
AAX_EProperty
AAX_EProperty
The list of properties that can be added to an AAX_IPropertyMap.
Definition: AAX_Properties.h:82
AAX
Definition: AAX_EnvironmentUtilities.h:72
AAX::IsFourCharASCII
bool IsFourCharASCII(uint32_t inFourChar)
Definition: AAX_StringUtilities.hpp:235
AAX::AsStringPropertyValue
std::string AsStringPropertyValue(AAX_EProperty inProperty, AAX_CPropertyValue inPropertyValue)
Definition: AAX_StringUtilities.hpp:307
AAX::AsStringFourChar
std::string AsStringFourChar(uint32_t inFourChar)
Definition: AAX_StringUtilities.hpp:250
AAX::AsStringStemFormat
std::string AsStringStemFormat(AAX_EStemFormat inStemFormat, bool inAbbreviate=false)
Definition: AAX_StringUtilities.hpp:362
AAX::AsStringResult
std::string AsStringResult(AAX_Result inResult)
Definition: AAX_StringUtilities.hpp:786
AAX::Caseless_strcmp
int32_t Caseless_strcmp(const char *cs, const char *ct)
Definition: AAX_StringUtilities.hpp:143
AAX::Binary2String
std::string Binary2String(uint32_t binaryValue, int32_t numBits)
Definition: AAX_StringUtilities.hpp:186
AAX::AsStringSupportLevel
std::string AsStringSupportLevel(AAX_ESupportLevel inSupportLevel)
Definition: AAX_StringUtilities.hpp:847
AAX::String2Binary
uint32_t String2Binary(const AAX_IString &s)
Definition: AAX_StringUtilities.hpp:207
AAX::AsStringIDTriad
std::string AsStringIDTriad(const AAX_SPlugInIdentifierTriad &inIDTriad)
Definition: AAX_StringUtilities.hpp:350
AAX::GetCStringOfLength
void GetCStringOfLength(char *stringOut, const char *stringIn, int32_t aMaxChars)
==============================================================
Definition: AAX_StringUtilities.hpp:103
AAX::IsASCII
bool IsASCII(char inChar)
Definition: AAX_StringUtilities.hpp:230
AAX::AsStringInt32
std::string AsStringInt32(int32_t inInt32)
Definition: AAX_StringUtilities.hpp:340
AAX::AsStringUInt32
std::string AsStringUInt32(uint32_t inUInt32)
Definition: AAX_StringUtilities.hpp:345
AAX::AsStringStemChannel
std::string AsStringStemChannel(AAX_EStemFormat inStemFormat, uint32_t inChannelIndex, bool inAbbreviate)
Definition: AAX_StringUtilities.hpp:411
AAX_SPlugInIdentifierTriad
Plug-in Identifier Triad.
Definition: AAX.h:566
AAX_IString
A simple string container that can be passed across a binary boundary. This class,...
Definition: AAX_IString.h:51