File: MIDIAccess.h

package info (click to toggle)
firefox 144.0-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 4,637,504 kB
  • sloc: cpp: 7,576,692; javascript: 6,430,831; ansic: 3,748,119; python: 1,398,978; xml: 628,810; asm: 438,679; java: 186,194; sh: 63,212; makefile: 19,159; objc: 13,086; perl: 12,986; yacc: 4,583; cs: 3,846; pascal: 3,448; lex: 1,720; ruby: 1,003; exp: 762; php: 436; lisp: 258; awk: 247; sql: 66; sed: 53; csh: 10
file content (105 lines) | stat: -rw-r--r-- 3,469 bytes parent folder | download | duplicates (12)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim:set ts=2 sw=2 sts=2 et cindent: */
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

#ifndef mozilla_dom_MIDIAccess_h
#define mozilla_dom_MIDIAccess_h

#include "mozilla/Attributes.h"
#include "mozilla/DOMEventTargetHelper.h"
#include "mozilla/Observer.h"
#include "mozilla/WeakPtr.h"
#include "nsCycleCollectionParticipant.h"
#include "nsWrapperCache.h"

struct JSContext;

namespace mozilla {
class ErrorResult;

namespace dom {

class MIDIAccessManager;
class MIDIInputMap;
struct MIDIOptions;
class MIDIOutputMap;
class MIDIPermissionRequest;
class MIDIPort;
class MIDIPortChangeEvent;
class MIDIPortInfo;
class MIDIPortList;
class Promise;

/**
 * MIDIAccess is the DOM object that is handed to the user upon MIDI permissions
 * being successfully granted. It manages access to MIDI ports, and fires events
 * for device connection and disconnection.
 *
 * New MIDIAccess objects are created every time RequestMIDIAccess is called.
 * MIDIAccess objects are managed via MIDIAccessManager.
 */
class MIDIAccess final : public DOMEventTargetHelper,
                         public Observer<MIDIPortList> {
  // Use the Permission Request class in MIDIAccessManager for creating
  // MIDIAccess objects.
  friend class MIDIPermissionRequest;
  friend class MIDIAccessManager;

 public:
  NS_DECL_ISUPPORTS_INHERITED
  NS_DECL_CYCLE_COLLECTION_SCRIPT_HOLDER_CLASS_INHERITED(MIDIAccess,
                                                         DOMEventTargetHelper)
 public:
  virtual JSObject* WrapObject(JSContext* aCx,
                               JS::Handle<JSObject*> aGivenProto) override;

  // Return map of MIDI Input Ports
  MIDIInputMap* Inputs() const { return mInputMap; }

  // Return map of MIDI Output Ports
  MIDIOutputMap* Outputs() const { return mOutputMap; }

  // Returns true if sysex permissions were given
  bool SysexEnabled() const { return mSysexEnabled; }

  // Observer implementation for receiving port connection updates
  void Notify(const MIDIPortList& aEvent) override;

  // Fires DOM event on port connection/disconnection
  void FireConnectionEvent(MIDIPort* aPort);

  // Notify all MIDIPorts that were created by this MIDIAccess and are still
  // alive, and detach from the MIDIAccessManager.
  void Shutdown();
  IMPL_EVENT_HANDLER(statechange);

  void DisconnectFromOwner() override;

 private:
  MIDIAccess(nsPIDOMWindowInner* aWindow, bool aSysexEnabled,
             Promise* aAccessPromise);
  ~MIDIAccess();

  // On receiving a connection event from MIDIAccessManager, create a
  // corresponding MIDIPort object if we don't already have one.
  void MaybeCreateMIDIPort(const MIDIPortInfo& aInfo, ErrorResult& aRv);

  // Stores all known MIDIInput Ports
  RefPtr<MIDIInputMap> mInputMap;
  // Stores all known MIDIOutput Ports
  RefPtr<MIDIOutputMap> mOutputMap;
  // True if user gave permissions for sysex usage to this object.
  bool mSysexEnabled;
  // Promise created by RequestMIDIAccess call, to be resolved after port
  // populating is finished.
  RefPtr<Promise> mAccessPromise;
  // True if shutdown process has started, so we don't try to add more ports.
  bool mHasShutdown;
};

}  // namespace dom
}  // namespace mozilla

#endif  // mozilla_dom_MIDIAccess_h