rtsputil.h
上传用户:zhongxx05
上传日期:2007-06-06
资源大小:33641k
文件大小:7k
- /* ***** BEGIN LICENSE BLOCK *****
- * Version: RCSL 1.0/RPSL 1.0
- *
- * Portions Copyright (c) 1995-2002 RealNetworks, Inc. All Rights Reserved.
- *
- * The contents of this file, and the files included with this file, are
- * subject to the current version of the RealNetworks Public Source License
- * Version 1.0 (the "RPSL") available at
- * http://www.helixcommunity.org/content/rpsl unless you have licensed
- * the file under the RealNetworks Community Source License Version 1.0
- * (the "RCSL") available at http://www.helixcommunity.org/content/rcsl,
- * in which case the RCSL will apply. You may also obtain the license terms
- * directly from RealNetworks. You may not use this file except in
- * compliance with the RPSL or, if you have a valid RCSL with RealNetworks
- * applicable to this file, the RCSL. Please see the applicable RPSL or
- * RCSL for the rights, obligations and limitations governing use of the
- * contents of the file.
- *
- * This file is part of the Helix DNA Technology. RealNetworks is the
- * developer of the Original Code and owns the copyrights in the portions
- * it created.
- *
- * This file, and the files included with this file, is distributed and made
- * available on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
- * EXPRESS OR IMPLIED, AND REALNETWORKS HEREBY DISCLAIMS ALL SUCH WARRANTIES,
- * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY, FITNESS
- * FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
- *
- * Technology Compatibility Kit Test Suite(s) Location:
- * http://www.helixcommunity.org/content/tck
- *
- * Contributor(s):
- *
- * ***** END LICENSE BLOCK ***** */
- #ifndef _RTSPUTIL_H_
- #define _RTSPUTIL_H_
- /*
- * Function:
- * BinTo64
- *
- * Purpose:
- * Encode binary data into text using 64 characters from
- * the ANSI character set a base 64 values. Essentially
- * encodes 24 bits (3 bytes) into 4 6-bit base64 characters.
- *
- * Parameters:
- * pInBuf - pointer to buffer of binary data to be encoded
- * len - length of data to be encoded
- * pOutBuf - pointer to output buffer
- *
- * Returns:
- * length of encoded buffer
- *
- * Notes:
- * The output buffer should be about 33% larger than the input
- * buffer to hold the encoded data. Text is broken up into
- * 72 character lines.
- */
- INT32 BinTo64(const BYTE* pInBuf, INT32 len, char* pOutBuf);
- /*
- * Function:
- * BinToURL64
- *
- * Purpose:
- * Encode binary data into text using 64 characters from
- * the ANSI character set a base 64 values. Essentially
- * encodes 24 bits (3 bytes) into 4 6-bit base64 characters.
- *
- * Note: This function differs from BinTo64 in that the '*' and
- * '!' characters are used instead of the "/" and "+" chars.
- * This is useful if the encoded string is going to be used as
- * a URL parameter. The same BinFrom64 function can be used to
- * decode both encodings.
- *
- * Parameters:
- * pInBuf - pointer to buffer of binary data to be encoded
- * len - length of data to be encoded
- * pOutBuf - pointer to output buffer
- *
- * Returns:
- * length of encoded buffer
- *
- * Notes:
- * The output buffer should be about 33% larger than the input
- * buffer to hold the encoded data. Text is broken up into
- * 72 character lines.
- */
- INT32 BinToURL64(const BYTE* pInBuf, INT32 len, char* pOutBuf);
- /*
- * Function:
- * BinFrom64
- *
- * Purpose:
- * Decode base 64 text back into binary.
- *
- * Parameters:
- * pInBuf - pointer to buffer of encoded data
- * len - length of data to be decoded
- * pOutBuf - pointer to output buffer
- *
- * Returns:
- * length of decoded buffer or -1 if invalid input
- *
- * Notes:
- *
- */
- INT32 BinFrom64(const char* pInBuf, INT32 len, BYTE* pOutBuf);
- /*
- * Function:
- * EncodeCString
- *
- * Purpose:
- * Add escape ('') characters so strings containing
- * control characters can be used as data without
- * losing the control character interpretation.
- *
- * Parameters:
- * pInString - C-style zero terminated string to encode
- *
- * Returns:
- * Encoded string
- *
- */
- const char* EncodeCString(const char* pInString);
- /*
- * Function:
- * URLEscapeBuffer
- *
- * Purpose:
- * URL-Escapes the input buffer, translating illegal URL
- * characters into a % sign followed by the hex value of
- * that character.
- *
- * Parameters:
- * pInBuf - pointer to buffer of printable data to be encoded
- * len - length of data to be encoded
- * pOutBuf - pointer to output buffer
- *
- * Returns:
- * length of encoded buffer
- *
- * Notes:
- * The output buffer should be 3 times larger than the input
- * buffer to hold the encoded data. Each illegal URL character
- * will be translated to 3 characters (i.e. @ -> %40). The
- * output will not be NULL terminated.
- */
- INT32 URLEscapeBuffer(const char* pInBuf, INT32 len, char* pOutBuf);
- /*
- * Function:
- * URLEscapeBuffer2
- *
- * Purpose:
- * See RFC 1738. This function should do proper url escaping.
- *
- * Parameters:
- * pInBuf - pointer to buffer of printable data to be encoded
- * len - length of data to be encoded
- * pOutBuf - pointer to output buffer
- *
- * bReserved - Should reserved values be escaped in this string?
- *
- * Returns:
- * length of encoded buffer
- *
- * Notes:
- * See RFC1738
- * "Thus, only alphanumerics, the special characters "$-_.+!*'(),",
- * and reserved characters used for their reserved purposes may be
- * used unencoded within a URL."
- *
- * Reserved characters: ";", "/", "?", ":", "@", "=" and "&"
- *
- */
- INT32 URLEscapeBuffer2(const char* pInBuf, INT32 len, char* pOutBuf,
- BOOL bReserved);
- /*
- * Function:
- * URLUnescapeBuffer
- *
- * Purpose:
- * URL-Unescapes the input buffer, translating escaped
- * characters to their normal representation (i.e. %40 -> @).
- *
- * Parameters:
- * pInBuf - pointer to buffer of escaped data
- * len - length of data to be decoded
- * pOutBuf - pointer to output buffer
- *
- * Returns:
- * length of decoded buffer or -1 if invalid input
- *
- * Notes:
- * The output buffer must be at least the same size as the
- * input buffer, to handle the case in which the input buffer
- * contains no escaped characters. The output will not be NULL
- * terminated.
- */
- INT32 URLUnescapeBuffer(const char* pInBuf, INT32 len, char* pOutBuf);
- #endif /* _RTSPUTIL_H_ */