rtsputil.h
上传用户:zhongxx05
上传日期:2007-06-06
资源大小:33641k
文件大小:7k
源码类别:

Symbian

开发平台:

C/C++

  1. /* ***** BEGIN LICENSE BLOCK ***** 
  2.  * Version: RCSL 1.0/RPSL 1.0 
  3.  *  
  4.  * Portions Copyright (c) 1995-2002 RealNetworks, Inc. All Rights Reserved. 
  5.  *      
  6.  * The contents of this file, and the files included with this file, are 
  7.  * subject to the current version of the RealNetworks Public Source License 
  8.  * Version 1.0 (the "RPSL") available at 
  9.  * http://www.helixcommunity.org/content/rpsl unless you have licensed 
  10.  * the file under the RealNetworks Community Source License Version 1.0 
  11.  * (the "RCSL") available at http://www.helixcommunity.org/content/rcsl, 
  12.  * in which case the RCSL will apply. You may also obtain the license terms 
  13.  * directly from RealNetworks.  You may not use this file except in 
  14.  * compliance with the RPSL or, if you have a valid RCSL with RealNetworks 
  15.  * applicable to this file, the RCSL.  Please see the applicable RPSL or 
  16.  * RCSL for the rights, obligations and limitations governing use of the 
  17.  * contents of the file.  
  18.  *  
  19.  * This file is part of the Helix DNA Technology. RealNetworks is the 
  20.  * developer of the Original Code and owns the copyrights in the portions 
  21.  * it created. 
  22.  *  
  23.  * This file, and the files included with this file, is distributed and made 
  24.  * available on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER 
  25.  * EXPRESS OR IMPLIED, AND REALNETWORKS HEREBY DISCLAIMS ALL SUCH WARRANTIES, 
  26.  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY, FITNESS 
  27.  * FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT. 
  28.  * 
  29.  * Technology Compatibility Kit Test Suite(s) Location: 
  30.  *    http://www.helixcommunity.org/content/tck 
  31.  * 
  32.  * Contributor(s): 
  33.  *  
  34.  * ***** END LICENSE BLOCK ***** */ 
  35. #ifndef _RTSPUTIL_H_
  36. #define _RTSPUTIL_H_
  37. /*
  38.  * Function: 
  39.  *  BinTo64
  40.  *
  41.  * Purpose:
  42.  * Encode binary data into text using 64 characters from
  43.  * the ANSI character set a base 64 values. Essentially
  44.  * encodes 24 bits (3 bytes) into 4 6-bit base64 characters.
  45.  *
  46.  * Parameters:
  47.  * pInBuf - pointer to buffer of binary data to be encoded
  48.  *              len - length of data to be encoded
  49.  *              pOutBuf - pointer to output buffer
  50.  *
  51.  * Returns:
  52.  * length of encoded buffer
  53.  *
  54.  * Notes: 
  55.  * The output buffer should be about 33% larger than the input
  56.  *         buffer to hold the encoded data. Text is broken up into
  57.  *              72 character lines.
  58.  */
  59. INT32 BinTo64(const BYTE* pInBuf, INT32 len, char* pOutBuf);
  60. /*
  61.  * Function: 
  62.  *  BinToURL64
  63.  *
  64.  * Purpose:
  65.  * Encode binary data into text using 64 characters from
  66.  * the ANSI character set a base 64 values. Essentially
  67.  * encodes 24 bits (3 bytes) into 4 6-bit base64 characters.
  68.  *
  69.  *              Note: This function differs from BinTo64 in that the '*' and
  70.  *              '!' characters are used instead of the "/" and "+" chars. 
  71.  *              This is useful if the encoded string is going to be used as
  72.  *              a URL parameter. The same BinFrom64 function can be used to
  73.  *              decode both encodings.
  74.  *
  75.  * Parameters:
  76.  * pInBuf - pointer to buffer of binary data to be encoded
  77.  *              len - length of data to be encoded
  78.  *              pOutBuf - pointer to output buffer
  79.  *
  80.  * Returns:
  81.  * length of encoded buffer
  82.  *
  83.  * Notes: 
  84.  * The output buffer should be about 33% larger than the input
  85.  *         buffer to hold the encoded data. Text is broken up into
  86.  *              72 character lines.
  87.  */
  88. INT32 BinToURL64(const BYTE* pInBuf, INT32 len, char* pOutBuf);
  89. /*
  90.  * Function:
  91.  * BinFrom64
  92.  *
  93.  * Purpose:
  94.  * Decode base 64 text back into binary.
  95.  *
  96.  * Parameters:
  97.  * pInBuf - pointer to buffer of encoded data
  98.  * len - length of data to be decoded
  99.  * pOutBuf - pointer to output buffer
  100.  *
  101.  * Returns:
  102.  * length of decoded buffer or -1 if invalid input
  103.  *
  104.  * Notes:
  105.  *
  106.  */
  107. INT32 BinFrom64(const char* pInBuf, INT32 len, BYTE* pOutBuf);
  108. /*
  109.  * Function:
  110.  * EncodeCString
  111.  *
  112.  * Purpose:
  113.  * Add escape ('') characters so strings containing
  114.  * control characters can be used as data without
  115.  * losing the control character interpretation.
  116.  *
  117.  * Parameters:
  118.  * pInString - C-style zero terminated string to encode
  119.  *
  120.  * Returns:
  121.  * Encoded string
  122.  *
  123.  */
  124. const char* EncodeCString(const char* pInString);
  125. /*
  126.  * Function: 
  127.  *  URLEscapeBuffer
  128.  *
  129.  * Purpose:
  130.  * URL-Escapes the input buffer, translating illegal URL
  131.  * characters into a % sign followed by the hex value of
  132.  * that character.
  133.  *
  134.  * Parameters:
  135.  * pInBuf - pointer to buffer of printable data to be encoded
  136.  *              len - length of data to be encoded
  137.  *              pOutBuf - pointer to output buffer
  138.  *
  139.  * Returns:
  140.  * length of encoded buffer
  141.  *
  142.  * Notes: 
  143.  * The output buffer should be 3 times larger than the input
  144.  *         buffer to hold the encoded data. Each illegal URL character
  145.  *              will be translated to 3 characters (i.e. @ -> %40). The
  146.  * output will not be NULL terminated.
  147.  */
  148. INT32 URLEscapeBuffer(const char* pInBuf, INT32 len, char* pOutBuf);
  149. /*
  150.  * Function: 
  151.  *  URLEscapeBuffer2
  152.  *
  153.  * Purpose:
  154.  *  See RFC 1738.  This function should do proper url escaping.
  155.  *
  156.  * Parameters:
  157.  * pInBuf - pointer to buffer of printable data to be encoded
  158.  *              len - length of data to be encoded
  159.  *              pOutBuf - pointer to output buffer
  160.  *
  161.  *              bReserved - Should reserved values be escaped in this string?
  162.  *
  163.  * Returns:
  164.  * length of encoded buffer
  165.  *
  166.  * Notes:
  167.  *  See RFC1738
  168.  * "Thus, only alphanumerics, the special characters "$-_.+!*'(),",
  169.  * and reserved characters used for their reserved purposes may be
  170.  * used unencoded within a URL."
  171.  *
  172.  * Reserved characters: ";", "/", "?", ":", "@", "=" and "&" 
  173.  *
  174.  */
  175. INT32 URLEscapeBuffer2(const char* pInBuf, INT32 len, char* pOutBuf, 
  176.        BOOL bReserved);
  177. /*
  178.  * Function:
  179.  * URLUnescapeBuffer
  180.  *
  181.  * Purpose:
  182.  * URL-Unescapes the input buffer, translating escaped 
  183.  * characters to their normal representation (i.e. %40 -> @).
  184.  *
  185.  * Parameters:
  186.  * pInBuf - pointer to buffer of escaped data
  187.  * len - length of data to be decoded
  188.  * pOutBuf - pointer to output buffer
  189.  *
  190.  * Returns:
  191.  * length of decoded buffer or -1 if invalid input
  192.  *
  193.  * Notes:
  194.  * The output buffer must be at least the same size as the 
  195.  * input buffer, to handle the case in which the input buffer
  196.  * contains no escaped characters. The output will not be NULL
  197.  * terminated.
  198.  */
  199. INT32 URLUnescapeBuffer(const char* pInBuf, INT32 len, char* pOutBuf);
  200. #endif /* _RTSPUTIL_H_ */