src/third_party/WebKit/Source/modules/webmidi/MIDIAccess.h

   1 /*
   2  * Copyright (C) 2013 Google Inc. All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are
   6  * met:
   7  *
   8  *     * Redistributions of source code must retain the above copyright
   9  * notice, this list of conditions and the following disclaimer.
  10  *     * Redistributions in binary form must reproduce the above
  11  * copyright notice, this list of conditions and the following disclaimer
  12  * in the documentation and/or other materials provided with the
  13  * distribution.
  14  *     * Neither the name of Google Inc. nor the names of its
  15  * contributors may be used to endorse or promote products derived from
  16  * this software without specific prior written permission.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29  */
  30
  31 #ifndef MIDIAccess_h
  32 #define MIDIAccess_h
  33
  34 #include "bindings/core/v8/ScriptPromise.h"
  35 #include "core/dom/ActiveDOMObject.h"
  36 #include "modules/EventTargetModules.h"
  37 #include "modules/webmidi/MIDIAccessInitializer.h"
  38 #include "modules/webmidi/MIDIAccessor.h"
  39 #include "modules/webmidi/MIDIAccessorClient.h"
  40 #include "platform/heap/Handle.h"
  41 #include "wtf/Vector.h"
  42
  43 namespace blink {
  44
  45 class ExecutionContext;
  46 class MIDIInput;
  47 class MIDIInputMap;
  48 class MIDIOutput;
  49 class MIDIOutputMap;
  50
  51 class MIDIAccess FINAL : public RefCountedGarbageCollectedWillBeGarbageCollectedFinalized<MIDIAccess>, public ActiveDOMObject, public EventTargetWithInlineData, public MIDIAccessorClient {
  52     DEFINE_EVENT_TARGET_REFCOUNTING_WILL_BE_REMOVED(RefCountedGarbageCollected<MIDIAccess>);
  53     DEFINE_WRAPPERTYPEINFO();
  54     WILL_BE_USING_GARBAGE_COLLECTED_MIXIN(MIDIAccess);
  55 public:
  56     static MIDIAccess* create(PassOwnPtr<MIDIAccessor> accessor, bool sysexEnabled, const Vector<MIDIAccessInitializer::PortDescriptor>& ports, ExecutionContext* executionContext)
  57     {
  58         MIDIAccess* access = adoptRefCountedGarbageCollectedWillBeNoop(new MIDIAccess(accessor, sysexEnabled, ports, executionContext));
  59         access->suspendIfNeeded();
  60         return access;
  61     }
  62     virtual ~MIDIAccess();
  63
  64     MIDIInputMap* inputs() const;
  65     MIDIOutputMap* outputs() const;
  66
  67     DEFINE_ATTRIBUTE_EVENT_LISTENER(connect);
  68     DEFINE_ATTRIBUTE_EVENT_LISTENER(disconnect);
  69
  70     bool sysexEnabled() const { return m_sysexEnabled; }
  71
  72     // EventTarget
  73     virtual const AtomicString& interfaceName() const OVERRIDE { return EventTargetNames::MIDIAccess; }
  74     virtual ExecutionContext* executionContext() const OVERRIDE { return ActiveDOMObject::executionContext(); }
  75
  76     // ActiveDOMObject
  77     virtual void stop() OVERRIDE;
  78
  79     // MIDIAccessorClient
  80     virtual void didAddInputPort(const String& id, const String& manufacturer, const String& name, const String& version) OVERRIDE;
  81     virtual void didAddOutputPort(const String& id, const String& manufacturer, const String& name, const String& version) OVERRIDE;
  82     virtual void didStartSession(bool success, const String& error, const String& message) OVERRIDE
  83     {
  84         // This method is for MIDIAccess initialization: MIDIAccessInitializer
  85         // has the implementation.
  86         ASSERT_NOT_REACHED();
  87     }
  88     virtual void didReceiveMIDIData(unsigned portIndex, const unsigned char* data, size_t length, double timeStamp) OVERRIDE;
  89
  90     // |timeStampInMilliseconds| is in the same time coordinate system as performance.now().
  91     void sendMIDIData(unsigned portIndex, const unsigned char* data, size_t length, double timeStampInMilliseconds);
  92
  93     virtual void trace(Visitor*) OVERRIDE;
  94
  95 private:
  96     MIDIAccess(PassOwnPtr<MIDIAccessor>, bool sysexEnabled, const Vector<MIDIAccessInitializer::PortDescriptor>&, ExecutionContext*);
  97
  98     OwnPtr<MIDIAccessor> m_accessor;
  99     bool m_sysexEnabled;
 100     HeapVector<Member<MIDIInput> > m_inputs;
 101     HeapVector<Member<MIDIOutput> > m_outputs;
 102 };
 103
 104 } // namespace blink
 105
 106 #endif // MIDIAccess_h