/* ***** BEGIN LICENSE BLOCK *****
 * Source last modified: $Id: ogg_depack.h,v 1.1.2.2 2004/07/09 01:58:21 hubbe Exp $
 * 
 * Portions Copyright (c) 1995-2004 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 (the "RPSL") available at
 * http://www.helixcommunity.org/content/rpsl unless you have licensed
 * the file under the current version of the RealNetworks Community
 * Source License (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.
 * 
 * Alternatively, the contents of this file may be used under the
 * terms of the GNU General Public License Version 2 or later (the
 * "GPL") in which case the provisions of the GPL are applicable
 * instead of those above. If you wish to allow use of your version of
 * this file only under the terms of the GPL, and not to allow others
 * to use your version of this file under the terms of either the RPSL
 * or RCSL, indicate your decision by deleting the provisions above
 * and replace them with the notice and other provisions required by
 * the GPL. If you do not delete the provisions above, a recipient may
 * use your version of this file under the terms of any one of the
 * RPSL, the RCSL or the GPL.
 * 
 * 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 OGG_DEPACK_H
#define OGG_DEPACK_H

#include "vorbis_depack.h"
#include "queue.h"

class OggDepacketizer : public VorbisDepacketizer
{
public:
    /* Static creation function */
    static VorbisDepacketizer* Create();

    /* VorbisDepacketizer interface methods */

    /* Init()
     *   Called right after the object is created. 
     *   This allows the depacketizer to grab any
     *   interfaces it may need to do it's job.
     */
    virtual HX_RESULT Init(IUnknown* pContext);

    /* OnStreamHeader()
     *    Used to pass the stream header to the depacketizer 
     */
    virtual HX_RESULT OnStreamHeader(IHXValues* pStreamHdr);

    /* OnPacket()
     *    Called when a packet arrives 
     */
    virtual HX_RESULT OnPacket(IHXPacket* pPacket);

    /* GetVorbisPacket()
     *    Called to get the next vorbis packet 
     */
    virtual HX_RESULT GetVorbisPacket(REF(ogg_packet*) pVorbisPkt);

    /* Reset()
     *    Flushes the depacketizer. This should be called when a 
     *    seek occurs.
     */
    virtual HX_RESULT Reset();

    /* EndOfStream()
     *   Called after the last packet has been received.
     *   This lets the depacketizer know that it needs
     *   to output any packets it has left.
     */
    virtual HX_RESULT EndOfStream();

private:
    OggDepacketizer();
    virtual ~OggDepacketizer();
    
    void ClearQueue();

    Queue m_packetQueue;
    ogg_sync_state   m_oy;
    ogg_stream_state m_os;
    ogg_page         m_og;
    int              m_currentSerialNum;
    BOOL             m_bNeedPage;
};

#endif /* OGG_DEPACK_H */
