smlprstime.h
上传用户:dangjiwu
上传日期:2013-07-19
资源大小:42019k
文件大小:10k
源码类别:

Symbian

开发平台:

Visual C++

  1. /* ***** BEGIN LICENSE BLOCK *****
  2.  * Source last modified: $Id: smlprstime.h,v 1.1.22.1 2004/07/09 01:57:56 hubbe Exp $
  3.  * 
  4.  * Portions Copyright (c) 1995-2004 RealNetworks, Inc. All Rights Reserved.
  5.  * 
  6.  * The contents of this file, and the files included with this file,
  7.  * are subject to the current version of the RealNetworks Public
  8.  * Source License (the "RPSL") available at
  9.  * http://www.helixcommunity.org/content/rpsl unless you have licensed
  10.  * the file under the current version of the RealNetworks Community
  11.  * Source License (the "RCSL") available at
  12.  * http://www.helixcommunity.org/content/rcsl, in which case the RCSL
  13.  * will apply. You may also obtain the license terms directly from
  14.  * RealNetworks.  You may not use this file except in compliance with
  15.  * the RPSL or, if you have a valid RCSL with RealNetworks applicable
  16.  * to this file, the RCSL.  Please see the applicable RPSL or RCSL for
  17.  * the rights, obligations and limitations governing use of the
  18.  * contents of the file.
  19.  * 
  20.  * Alternatively, the contents of this file may be used under the
  21.  * terms of the GNU General Public License Version 2 or later (the
  22.  * "GPL") in which case the provisions of the GPL are applicable
  23.  * instead of those above. If you wish to allow use of your version of
  24.  * this file only under the terms of the GPL, and not to allow others
  25.  * to use your version of this file under the terms of either the RPSL
  26.  * or RCSL, indicate your decision by deleting the provisions above
  27.  * and replace them with the notice and other provisions required by
  28.  * the GPL. If you do not delete the provisions above, a recipient may
  29.  * use your version of this file under the terms of any one of the
  30.  * RPSL, the RCSL or the GPL.
  31.  * 
  32.  * This file is part of the Helix DNA Technology. RealNetworks is the
  33.  * developer of the Original Code and owns the copyrights in the
  34.  * portions it created.
  35.  * 
  36.  * This file, and the files included with this file, is distributed
  37.  * and made available on an 'AS IS' basis, WITHOUT WARRANTY OF ANY
  38.  * KIND, EITHER EXPRESS OR IMPLIED, AND REALNETWORKS HEREBY DISCLAIMS
  39.  * ALL SUCH WARRANTIES, INCLUDING WITHOUT LIMITATION, ANY WARRANTIES
  40.  * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, QUIET
  41.  * ENJOYMENT OR NON-INFRINGEMENT.
  42.  * 
  43.  * Technology Compatibility Kit Test Suite(s) Location:
  44.  *    http://www.helixcommunity.org/content/tck
  45.  * 
  46.  * Contributor(s):
  47.  * 
  48.  * ***** END LICENSE BLOCK ***** */
  49. #ifndef SMLPRSTI_H
  50. #define SMLPRSTI_H
  51. enum SmilTimeType
  52. {
  53.     SmilTimeNone,
  54.     SmilTimeOffset,
  55.     SmilTimeClockValue,
  56.     SmilTimeSyncBase,
  57. #if defined(ENABLE_SYNC_TO_PREV)
  58.     SmilTimeSyncToPrev,
  59. #endif
  60.     SmilTimeEvent,
  61.     SmilTimeMediaMarker,
  62.     SmilTimeWallclock
  63. };
  64. // Forward declarations
  65. class CSmilElement;
  66. class CHXString;
  67. class SmilTimeValue
  68. {
  69. public:
  70.     SmilTimeValue(IUnknown*     pContext,
  71.                   UINT32        ulStartLine,
  72.                   CSmilElement* pElement);
  73.     virtual ~SmilTimeValue();
  74.     HX_RESULT    parseValue(const char*          pPos,
  75.                             SMILSyncAttributeTag nTag,
  76.                             const char*          pThisElementID);
  77.     INT32        setTimeOffset(time_t refTime);
  78.     INT32        getTimeOffset() { return m_lOffset;}
  79.     SmilTimeType getTimeType() { return m_type; }
  80.     const char*  getEventName() { return (const char*) m_pEventName; }
  81.     void         handleAsEvent(const char* pstr)
  82.  { if (pstr)
  83.                      m_pEventName = (char*)pstr;
  84.                      m_bTreatSyncArcAsEvent = TRUE;
  85.  }
  86.     const char*  getIdRef() { return (const char*) m_idRef; }
  87.     BOOL         isTimeResolved() { return m_bTimeIsResolved; }
  88.     void         setIsTimeResolved(BOOL bIsResolved);
  89.     HX_RESULT    getEffectiveResolvedTime(REF(INT32) lEffectiveResolvedTime);
  90.     // /This sets the "base" time it resolved to, i.e., without the offset:
  91.     void         setResolvedToTime(INT32 lWhen) { m_lResolvedToTime = lWhen; }
  92.     INT32        getResolvedToTimeWithoutOffset() { return m_lResolvedToTime; }
  93.     // /XXXEH- not sure yet whether we need these 2 functions:
  94.     INT32        getWhenTimeWasResolved() { return m_lWhenTimeWasResolved; }
  95.     void         setWhenTimeWasResolved(INT32 lWhen) { m_lWhenTimeWasResolved = lWhen; }
  96. #if defined(ENABLE_SYNC_TO_PREV)
  97.     BOOL         isSyncBaseTimeVal() { return (SmilTimeSyncBase   == m_type ||
  98.                                                SmilTimeSyncToPrev == m_type); }
  99. #else
  100.     BOOL         isSyncBaseTimeVal() { return (SmilTimeSyncBase == m_type); }
  101. #endif
  102.     BOOL  isResumeEvent() { return (m_type == SmilTimeEvent  &&  m_pEventName
  103. &&  0==strcmp(m_pEventName, "resumeEvent")); }
  104.     BOOL  isUndeferEvent() { return (m_type == SmilTimeEvent  &&  m_pEventName
  105. &&  0==strcmp(m_pEventName, "undeferEvent")); }
  106.     HX_RESULT  setPauseTime(LONG32 lTimeOfPause);
  107.     ULONG32  getPauseTime() { return m_lTimeOfPause;}
  108.     BOOL         isSameTimeValue(SmilTimeValue* pOtherTimeVal);
  109.     BOOL         deferUntil(LONG32 lNewStartTime);
  110.     // Media-marker-related
  111.     const char*  getFullMarkerName()         const { return m_pszMarkerName;             }
  112.     BOOL         isExternalMarker()          const { return m_bIsExternalMarker;         }
  113.     const char*  getExternalMarkerFileName() const { return m_pszExternalMarkerFileName; }
  114.     const char*  getExternalMarkerName()     const { return m_pszExternalMarkerName;     }
  115.     const char*  getMarkerName()             const { return (m_bIsExternalMarker     ?
  116.                                                              m_pszExternalMarkerName :
  117.                                                              m_pszMarkerName);           }
  118.     void         setMarkerTime(UINT32 ulTime);
  119.     // /Point back at "owner" of this:
  120.     CSmilElement*      m_pElement;
  121.     // /This is "foo" in the following example: "foo.beginEvent+5s"
  122.     CHXString          m_idRef;
  123.     // /This is id of element that deferred us:
  124.     CHXString          m_awaitingThisOnesEndForUndefer;
  125.     SMILEventSourceTag m_position;
  126.     // /This is the '5' in: begin="foo.repeat(5)":
  127.     UINT16             m_uRepeatIteration;
  128.     SmilTimeType       m_type;
  129.     // ONLY HX_BITFIELD MEMBERS SHOULD GO BELOW THIS LINE!
  130.     // ALL OTHER MEMBER TYPES SHOULD GO ABOVE THIS LINE!
  131.     HX_BITFIELD        m_bTreatSyncArcAsEvent : 1;
  132. private:
  133.     HX_RESULT parseOffset(const char* pCh);
  134.     HX_RESULT parseClockValue(const char* pValue, UINT32& ulTimeValue);
  135. #if defined(ENABLE_SYNC_TO_PREV)
  136.     HX_RESULT parseSyncToPrev(REF(const char*) pPos);
  137. #endif
  138.     HX_RESULT parseWallClockValue(REF(const char*) pCh);
  139.     HX_RESULT parseEvent(const char* pBase, const char* pEvent, const char* pOffset);
  140.     HX_RESULT parseSyncBase(const char* pBase, const char* pEvent, const char* pOffset);
  141.     HX_RESULT parseMarker(const char* pBase, const char* pEvent, const char* pOffset);
  142.     IUnknown* m_pContext;
  143.     UINT32    m_ulStartLine;
  144.     // /This is the time offset from a sync-arc or event-arc, e.g.,
  145.     // this is 5000 (milliseconds) in the following example:
  146.     // "foo.beginEvent+5s":
  147.     INT32     m_lOffset;
  148.     // /Deferring and other things can change m_lOffset; this keeps track of
  149.     // what it was set to originally in case we restart:
  150.     INT32     m_lOriginalOffset;
  151.     // the date defaults to -1/-1/-1 :==> today...
  152.     INT16     m_year;
  153.     INT8      m_month;
  154.     INT8      m_day;
  155.     // the time defaults to 00:00:00.0
  156.     UINT8     m_hour;
  157.     UINT8     m_min;
  158.     UINT8     m_sec;
  159.     UINT16    m_ms;
  160.     // defaults to 0: local time
  161.     INT16     m_UTCOffsetMin;
  162.     // media-marker-related
  163.     char*     m_pszMarkerName; // in begin="foo.marker()", this is what's inside the ()
  164.     char*     m_pszExternalMarkerFileName; // in begin="foo.marker(foo.mmr#A)", this is "foo.mmr"
  165.     char*     m_pszExternalMarkerName;     // in begin="foo.marker(foo.mmr#A)", this is "A"
  166.     UINT32    m_ulMarkerTime;
  167.     // /This is "beginEvent" in the following example: "foo.beginEvent+5s"
  168.     char*     m_pEventName;
  169.     // /This is the time that a non-clock/offset time resolved to; it differs
  170.     // from m_lWhenTimeWasResolved in cases like pure sync-arc timing where
  171.     // the resolved-to time is calculatable well in advance of the time it
  172.     // was resolved:
  173.     INT32     m_lResolvedToTime;
  174.     // /This is the time passed in to CSmilParser::tryToResolveBeginEndEvents
  175.     // which gets called whenever an event occurs.  We need this because
  176.     // this tells us *when* we resolved and we want to keep this separate
  177.     // from the m_lOffset in case it is negative, in which case our offset
  178.     // is really m_lWhenTimeResolved with a clip-begin of m_lOffset:
  179.     // /XXXEH- TODO: make sure final SMIL Boston spec agrees with above and
  180.     // also, make sure that sync-arc and other time values that resolve after
  181.     // the start of the presentation also get this set:
  182.     INT32     m_lWhenTimeWasResolved;
  183.     // /For resume event times, this keeps track of when *this was created so
  184.     // we can recalculate the element's end time when a resume is needed:
  185.     INT32     m_lTimeOfPause;
  186.     // ONLY HX_BITFIELD MEMBERS SHOULD GO BELOW THIS LINE!
  187.     // ALL OTHER MEMBER TYPES SHOULD GO ABOVE THIS LINE!
  188.     HX_BITFIELD m_bRelativeToUTC : 1; // defaults to FALSE, relative to local time
  189.     HX_BITFIELD m_bIsExternalMarker : 1;
  190.     HX_BITFIELD m_bUsedToBeMediaMarker : 1;
  191.     // /XXEH- TODO: make sure to reset this to FALSE whenever a repeat (or
  192.     // seek?) happens:
  193.     // /This says whether or not this's time is resolved to a clock val;
  194.     HX_BITFIELD m_bTimeIsResolved : 1;
  195. };
  196. #endif