Source/WebCore/platform/graphics/avfoundation/MediaSelectionGroupAVFObjC.h

/*
 * Copyright (C) 2014 Apple Inc. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 * THE POSSIBILITY OF SUCH DAMAGE.
 */

#pragma once

#if ENABLE(VIDEO)

#include "Timer.h"
#include <wtf/HashMap.h>
#include <wtf/IteratorRange.h>
#include <wtf/Ref.h>
#include <wtf/RefCounted.h>
#include <wtf/RefPtr.h>
#include <wtf/RetainPtr.h>
#include <wtf/text/WTFString.h>

OBJC_CLASS AVPlayerItem;
OBJC_CLASS AVMediaSelectionGroup;
OBJC_CLASS AVMediaSelectionOption;

namespace WebCore {

class MediaSelectionGroupAVFObjC;

class MediaSelectionOptionAVFObjC : public RefCounted<MediaSelectionOptionAVFObjC> {
public:
    static Ref<MediaSelectionOptionAVFObjC> create(MediaSelectionGroupAVFObjC&, AVMediaSelectionOption *);

    void setSelected(bool);
    bool selected() const;

    int index() const;

    AVMediaSelectionOption *avMediaSelectionOption() const { return m_mediaSelectionOption.get(); }
    AVAssetTrack *assetTrack() const;

private:
    friend class MediaSelectionGroupAVFObjC;
    MediaSelectionOptionAVFObjC(MediaSelectionGroupAVFObjC&, AVMediaSelectionOption *);

    void clearGroup() { m_group = nullptr; }

    MediaSelectionGroupAVFObjC* m_group;
    RetainPtr<AVMediaSelectionOption> m_mediaSelectionOption;
};

class MediaSelectionGroupAVFObjC : public RefCounted<MediaSelectionGroupAVFObjC> {
public:
    static Ref<MediaSelectionGroupAVFObjC> create(AVPlayerItem*, AVMediaSelectionGroup*, const Vector<String>& characteristics);
    ~MediaSelectionGroupAVFObjC();

    void setSelectedOption(MediaSelectionOptionAVFObjC*);
    MediaSelectionOptionAVFObjC* selectedOption() const { return m_selectedOption; }

    void updateOptions(const Vector<String>& characteristics);

    using OptionContainer = HashMap<CFTypeRef, RefPtr<MediaSelectionOptionAVFObjC>>;
    typename OptionContainer::ValuesIteratorRange options() { return m_options.values(); }

    AVMediaSelectionGroup *avMediaSelectionGroup() const { return m_mediaSelectionGroup.get(); }

private:
    MediaSelectionGroupAVFObjC(AVPlayerItem*, AVMediaSelectionGroup*, const Vector<String>& characteristics);

    void selectionTimerFired();

    RetainPtr<AVPlayerItem> m_playerItem;
    RetainPtr<AVMediaSelectionGroup> m_mediaSelectionGroup;
    OptionContainer m_options;
    MediaSelectionOptionAVFObjC* m_selectedOption { nullptr };
    Timer m_selectionTimer;
    bool m_shouldSelectOptionAutomatically { true };
};

}

#endif // ENABLE(VIDEO)