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

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 SMLPRSTI_H
  36. #define SMLPRSTI_H
  37. enum SmilTimeType
  38. {
  39.     SmilTimeNone,
  40.     SmilTimeOffset,
  41.     SmilTimeClockValue,
  42.     SmilTimeSyncBase,
  43. #if defined(ENABLE_SYNC_TO_PREV)
  44.     SmilTimeSyncToPrev,
  45. #endif
  46.     SmilTimeEvent,
  47.     SmilTimeMediaMarker,
  48.     SmilTimeWallclock
  49. };
  50. // Forward declarations
  51. class CSmilElement;
  52. class CHXString;
  53. class SmilTimeValue
  54. {
  55. public:
  56.     SmilTimeValue(IUnknown*     pContext,
  57.                   UINT32        ulStartLine,
  58.                   CSmilElement* pElement);
  59.     virtual ~SmilTimeValue();
  60.     HX_RESULT    parseValue(const char*          pPos,
  61.                             SMILSyncAttributeTag nTag,
  62.                             const char*          pThisElementID);
  63.     INT32        setTimeOffset(time_t refTime);
  64.     INT32        getTimeOffset() { return m_lOffset;}
  65.     SmilTimeType getTimeType() { return m_type; }
  66.     const char*  getEventName() { return (const char*) m_pEventName; }
  67.     void         handleAsEvent(const char* pstr)
  68.  { if (pstr)
  69.                      m_pEventName = (char*)pstr;
  70.                      m_bTreatSyncArcAsEvent = TRUE;
  71.  }
  72.     const char*  getIdRef() { return (const char*) m_idRef; }
  73.     BOOL         isTimeResolved() { return m_bTimeIsResolved; }
  74.     void         setIsTimeResolved(BOOL bIsResolved);
  75.     HX_RESULT    getEffectiveResolvedTime(REF(INT32) lEffectiveResolvedTime);
  76.     // /This sets the "base" time it resolved to, i.e., without the offset:
  77.     void         setResolvedToTime(INT32 lWhen) { m_lResolvedToTime = lWhen; }
  78.     INT32        getResolvedToTimeWithoutOffset() { return m_lResolvedToTime; }
  79.     // /XXXEH- not sure yet whether we need these 2 functions:
  80.     INT32        getWhenTimeWasResolved() { return m_lWhenTimeWasResolved; }
  81.     void         setWhenTimeWasResolved(INT32 lWhen) { m_lWhenTimeWasResolved = lWhen; }
  82. #if defined(ENABLE_SYNC_TO_PREV)
  83.     BOOL         isSyncBaseTimeVal() { return (SmilTimeSyncBase   == m_type ||
  84.                                                SmilTimeSyncToPrev == m_type); }
  85. #else
  86.     BOOL         isSyncBaseTimeVal() { return (SmilTimeSyncBase == m_type); }
  87. #endif
  88.     BOOL  isResumeEvent() { return (m_type == SmilTimeEvent  &&  m_pEventName
  89. &&  0==strcmp(m_pEventName, "resumeEvent")); }
  90.     BOOL  isUndeferEvent() { return (m_type == SmilTimeEvent  &&  m_pEventName
  91. &&  0==strcmp(m_pEventName, "undeferEvent")); }
  92.     HX_RESULT  setPauseTime(LONG32 lTimeOfPause);
  93.     ULONG32  getPauseTime() { return m_lTimeOfPause;}
  94.     BOOL         isSameTimeValue(SmilTimeValue* pOtherTimeVal);
  95.     BOOL         deferUntil(LONG32 lNewStartTime);
  96.     // Media-marker-related
  97.     const char*  getFullMarkerName()         const { return m_pszMarkerName;             }
  98.     BOOL         isExternalMarker()          const { return m_bIsExternalMarker;         }
  99.     const char*  getExternalMarkerFileName() const { return m_pszExternalMarkerFileName; }
  100.     const char*  getExternalMarkerName()     const { return m_pszExternalMarkerName;     }
  101.     const char*  getMarkerName()             const { return (m_bIsExternalMarker     ?
  102.                                                              m_pszExternalMarkerName :
  103.                                                              m_pszMarkerName);           }
  104.     void         setMarkerTime(UINT32 ulTime);
  105.     // /Point back at "owner" of this:
  106.     CSmilElement*      m_pElement;
  107.     // /This is "foo" in the following example: "foo.beginEvent+5s"
  108.     CHXString          m_idRef;
  109.     // /This is id of element that deferred us:
  110.     CHXString          m_awaitingThisOnesEndForUndefer;
  111.     SMILEventSourceTag m_position;
  112.     // /This is the '5' in: begin="foo.repeat(5)":
  113.     UINT16             m_uRepeatIteration;
  114.     SmilTimeType       m_type;
  115.     // ONLY HX_BITFIELD MEMBERS SHOULD GO BELOW THIS LINE!
  116.     // ALL OTHER MEMBER TYPES SHOULD GO ABOVE THIS LINE!
  117.     HX_BITFIELD        m_bTreatSyncArcAsEvent : 1;
  118. private:
  119.     HX_RESULT parseOffset(const char* pCh);
  120.     HX_RESULT parseClockValue(const char* pValue, UINT32& ulTimeValue);
  121. #if defined(ENABLE_SYNC_TO_PREV)
  122.     HX_RESULT parseSyncToPrev(REF(const char*) pPos);
  123. #endif
  124.     HX_RESULT parseWallClockValue(REF(const char*) pCh);
  125.     HX_RESULT parseEvent(const char* pBase, const char* pEvent, const char* pOffset);
  126.     HX_RESULT parseSyncBase(const char* pBase, const char* pEvent, const char* pOffset);
  127.     HX_RESULT parseMarker(const char* pBase, const char* pEvent, const char* pOffset);
  128.     IUnknown* m_pContext;
  129.     UINT32    m_ulStartLine;
  130.     // /This is the time offset from a sync-arc or event-arc, e.g.,
  131.     // this is 5000 (milliseconds) in the following example:
  132.     // "foo.beginEvent+5s":
  133.     INT32     m_lOffset;
  134.     // /Deferring and other things can change m_lOffset; this keeps track of
  135.     // what it was set to originally in case we restart:
  136.     INT32     m_lOriginalOffset;
  137.     // the date defaults to -1/-1/-1 :==> today...
  138.     INT16     m_year;
  139.     INT8      m_month;
  140.     INT8      m_day;
  141.     // the time defaults to 00:00:00.0
  142.     UINT8     m_hour;
  143.     UINT8     m_min;
  144.     UINT8     m_sec;
  145.     UINT16    m_ms;
  146.     // defaults to 0: local time
  147.     INT16     m_UTCOffsetMin;
  148.     // media-marker-related
  149.     char*     m_pszMarkerName; // in begin="foo.marker()", this is what's inside the ()
  150.     char*     m_pszExternalMarkerFileName; // in begin="foo.marker(foo.mmr#A)", this is "foo.mmr"
  151.     char*     m_pszExternalMarkerName;     // in begin="foo.marker(foo.mmr#A)", this is "A"
  152.     UINT32    m_ulMarkerTime;
  153.     // /This is "beginEvent" in the following example: "foo.beginEvent+5s"
  154.     char*     m_pEventName;
  155.     // /This is the time that a non-clock/offset time resolved to; it differs
  156.     // from m_lWhenTimeWasResolved in cases like pure sync-arc timing where
  157.     // the resolved-to time is calculatable well in advance of the time it
  158.     // was resolved:
  159.     INT32     m_lResolvedToTime;
  160.     // /This is the time passed in to CSmilParser::tryToResolveBeginEndEvents
  161.     // which gets called whenever an event occurs.  We need this because
  162.     // this tells us *when* we resolved and we want to keep this separate
  163.     // from the m_lOffset in case it is negative, in which case our offset
  164.     // is really m_lWhenTimeResolved with a clip-begin of m_lOffset:
  165.     // /XXXEH- TODO: make sure final SMIL Boston spec agrees with above and
  166.     // also, make sure that sync-arc and other time values that resolve after
  167.     // the start of the presentation also get this set:
  168.     INT32     m_lWhenTimeWasResolved;
  169.     // /For resume event times, this keeps track of when *this was created so
  170.     // we can recalculate the element's end time when a resume is needed:
  171.     INT32     m_lTimeOfPause;
  172.     // ONLY HX_BITFIELD MEMBERS SHOULD GO BELOW THIS LINE!
  173.     // ALL OTHER MEMBER TYPES SHOULD GO ABOVE THIS LINE!
  174.     HX_BITFIELD m_bRelativeToUTC : 1; // defaults to FALSE, relative to local time
  175.     HX_BITFIELD m_bIsExternalMarker : 1;
  176.     HX_BITFIELD m_bUsedToBeMediaMarker : 1;
  177.     // /XXEH- TODO: make sure to reset this to FALSE whenever a repeat (or
  178.     // seek?) happens:
  179.     // /This says whether or not this's time is resolved to a clock val;
  180.     HX_BITFIELD m_bTimeIsResolved : 1;
  181. };
  182. #endif