media/midi/midi_manager_alsa.h

   1 // Copyright 2014 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef MEDIA_MIDI_MIDI_MANAGER_ALSA_H_
   6 #define MEDIA_MIDI_MIDI_MANAGER_ALSA_H_
   7
   8 #include <alsa/asoundlib.h>
   9 #include <map>
  10 #include <vector>
  11
  12 #include "base/basictypes.h"
  13 #include "base/gtest_prod_util.h"
  14 #include "base/memory/scoped_ptr.h"
  15 #include "base/synchronization/lock.h"
  16 #include "base/threading/thread.h"
  17 #include "base/values.h"
  18 #include "media/midi/midi_manager.h"
  19
  20 #if defined(USE_UDEV)
  21 #include "device/udev_linux/scoped_udev.h"
  22 #endif  // defined(USE_UDEV)
  23
  24 namespace media {
  25
  26 class MEDIA_EXPORT MidiManagerAlsa : public MidiManager {
  27  public:
  28   MidiManagerAlsa();
  29   ~MidiManagerAlsa() override;
  30
  31   // MidiManager implementation.
  32   void StartInitialization() override;
  33   void DispatchSendMidiData(MidiManagerClient* client,
  34                             uint32 port_index,
  35                             const std::vector<uint8>& data,
  36                             double timestamp) override;
  37
  38  private:
  39   FRIEND_TEST_ALL_PREFIXES(MidiManagerAlsaTest, ExtractManufacturer);
  40   FRIEND_TEST_ALL_PREFIXES(MidiManagerAlsaTest, JSONPortMetadata);
  41
  42   class AlsaCard {
  43    public:
  44     AlsaCard(const MidiManagerAlsa* outer,
  45              const std::string& alsa_name,
  46              const std::string& alsa_longname,
  47              const std::string& alsa_driver,
  48              int card_index,
  49              int midi_count);
  50     ~AlsaCard();
  51
  52     const std::string alsa_name() const;
  53     const std::string alsa_longname() const;
  54     const std::string manufacturer() const;
  55     const std::string alsa_driver() const;
  56     const std::string path() const;
  57     const std::string bus() const;
  58     const std::string vendor_id() const;
  59     const std::string id() const;
  60     const int midi_count() const;
  61
  62    private:
  63     FRIEND_TEST_ALL_PREFIXES(MidiManagerAlsaTest, ExtractManufacturer);
  64
  65     // Extracts the manufacturer using heuristics and a variety of sources.
  66     static std::string ExtractManufacturerString(
  67         const std::string& udev_id_vendor,
  68         const std::string& udev_id_vendor_id,
  69         const std::string& udev_id_vendor_from_database,
  70         const std::string& alsa_name,
  71         const std::string& alsa_longname);
  72
  73     std::string alsa_name_;
  74     std::string alsa_longname_;
  75     std::string manufacturer_;
  76     std::string alsa_driver_;
  77     std::string path_;
  78     std::string bus_;
  79     std::string vendor_id_;
  80     std::string model_id_;
  81     std::string usb_interface_num_;
  82     int midi_count_;
  83
  84     DISALLOW_COPY_AND_ASSIGN(AlsaCard);
  85   };
  86
  87   class AlsaPortMetadata {
  88    public:
  89     enum class Type { kInput, kOutput };
  90
  91     AlsaPortMetadata(const std::string& path,
  92                      const std::string& bus,
  93                      const std::string& id,
  94                      const snd_seq_addr_t* address,
  95                      const std::string& client_name,
  96                      const std::string& port_name,
  97                      const std::string& card_name,
  98                      const std::string& card_longname,
  99                      Type type);
 100     ~AlsaPortMetadata();
 101
 102     // Gets a Value representation of this object, suitable for serialization.
 103     scoped_ptr<base::Value> Value() const;
 104
 105     // Gets a string version of Value in JSON format.
 106     std::string JSONValue() const;
 107
 108     // Gets an opaque identifier for this object, suitable for using as the id
 109     // field in MidiPort.id on the web. Note that this string does not store
 110     // the full state.
 111     std::string OpaqueKey() const;
 112
 113    private:
 114     FRIEND_TEST_ALL_PREFIXES(MidiManagerAlsaTest, JSONPortMetadata);
 115
 116     const std::string path_;
 117     const std::string bus_;
 118     const std::string id_;
 119     const int client_addr_;
 120     const int port_addr_;
 121     const std::string client_name_;
 122     const std::string port_name_;
 123     const std::string card_name_;
 124     const std::string card_longname_;
 125     const Type type_;
 126
 127     DISALLOW_COPY_AND_ASSIGN(AlsaPortMetadata);
 128   };
 129
 130   // Returns an ordered vector of all the cards with MIDI capabilities.
 131   ScopedVector<AlsaCard> AllMidiCards();
 132
 133   // Enumerate all the ports for initial setup.
 134   void EnumeratePorts();
 135
 136   // An internal callback that runs on MidiSendThread.
 137   void SendMidiData(uint32 port_index,
 138                     const std::vector<uint8>& data);
 139
 140   void ScheduleEventLoop();
 141   void EventLoop();
 142   void ProcessSingleEvent(snd_seq_event_t* event, double timestamp);
 143
 144   // ALSA seq handles.
 145   snd_seq_t* in_client_;
 146   snd_seq_t* out_client_;
 147   int out_client_id_;
 148
 149   // One input port, many output ports.
 150   int in_port_;
 151   std::vector<int> out_ports_;
 152
 153   // Mapping from ALSA client:port to our index.
 154   typedef std::map<int, uint32> SourceMap;
 155   SourceMap source_map_;
 156
 157   // ALSA event <-> MIDI coders.
 158   snd_midi_event_t* decoder_;
 159
 160   // udev, for querying hardware devices.
 161 #if defined(USE_UDEV)
 162   device::ScopedUdevPtr udev_;
 163 #endif  // defined(USE_UDEV)
 164
 165   base::Thread send_thread_;
 166   base::Thread event_thread_;
 167
 168   bool event_thread_shutdown_; // guarded by shutdown_lock_
 169   base::Lock shutdown_lock_; // guards event_thread_shutdown_
 170
 171   DISALLOW_COPY_AND_ASSIGN(MidiManagerAlsa);
 172 };
 173
 174 }  // namespace media
 175
 176 #endif  // MEDIA_MIDI_MIDI_MANAGER_ALSA_H_