<?xml version="1.0"?>
<rss version="2.0">
	<channel>
		<title>Mac OS X Joystick Bug (A5)</title>
		<link>http://www.allegro.cc/forums/view/608122</link>
		<description>Allegro.cc Forum Thread</description>
		<webMaster>matthew@allegro.cc (Matthew Leverton)</webMaster>
		<lastBuildDate>Fri, 19 Aug 2011 06:20:21 +0000</lastBuildDate>
	</channel>
	<item>
		<description><![CDATA[<div class="mockup v2"><p>In my current project I allow the player to configure multiple controllers if they have them hooked up. I just tried to play my game with two joysticks on my Mac and noticed that the game froze during initialization.</p><p>I tracked the freeze down to a function in <tt>hidjoy.m</tt>, <span class="source-code">init_joystick<span class="k2">(</span><span class="k2">)</span></span>. In that function there is a <span class="source-code"><span class="k1">do</span><span class="k3">/</span><span class="k1">while</span></span> loop that never exits. After tinkering with the code I think there is a problem in this function:</p><div class="source-code"><div class="toolbar"><span class="button numbers"><b>#</b></span><span class="button select">Select</span><span class="button expand">Expand</span></div><div class="inner"><span class="number">  1</span><span class="k1">static</span> <span class="k1">void</span> device_add_callback<span class="k2">(</span>
<span class="number">  2</span>   <span class="k1">void</span> <span class="k3">*</span>context,
<span class="number">  3</span>   IOReturn result,
<span class="number">  4</span>   <span class="k1">void</span> <span class="k3">*</span>sender,
<span class="number">  5</span>   IOHIDDeviceRef ref
<span class="number">  6</span><span class="k2">)</span> <span class="k2">{</span>
<span class="number">  7</span>   <span class="k1">int</span> i<span class="k2">;</span>
<span class="number">  8</span>
<span class="number">  9</span>   <span class="k2">(</span><span class="k1">void</span><span class="k2">)</span>context<span class="k2">;</span>
<span class="number"> 10</span>   <span class="k2">(</span><span class="k1">void</span><span class="k2">)</span>result<span class="k2">;</span>
<span class="number"> 11</span>   <span class="k2">(</span><span class="k1">void</span><span class="k2">)</span>sender<span class="k2">;</span>
<span class="number"> 12</span>   
<span class="number"> 13</span>   <a href="http://www.allegro.cc/manual/al_lock_mutex"><span class="a">al_lock_mutex</span></a><span class="k2">(</span>add_mutex<span class="k2">)</span><span class="k2">;</span>
<span class="number"> 14</span>
<span class="number"> 15</span>   CFTypeRef product_id  <span class="k3">=</span> get_device_product_id<span class="k2">(</span>ref<span class="k2">)</span><span class="k2">;</span>
<span class="number"> 16</span>
<div class="highlight"><span class="number"> 17</span>   ALLEGRO_JOYSTICK_OSX <span class="k3">*</span><a href="http://www.allegro.cc/manual/joy"><span class="a">joy</span></a> <span class="k3">=</span> find_joystick<span class="k2">(</span>product_id<span class="k2">)</span><span class="k2">;</span> </div><span class="number"> 18</span>   <span class="k1">if</span> <span class="k2">(</span><a href="http://www.allegro.cc/manual/joy"><span class="a">joy</span></a> <span class="k3">=</span><span class="k3">=</span> NULL<span class="k2">)</span> <span class="k2">{</span>
<span class="number"> 19</span>      <a href="http://www.allegro.cc/manual/joy"><span class="a">joy</span></a> <span class="k3">=</span> <a href="http://www.allegro.cc/manual/al_calloc"><span class="a">al_calloc</span></a><span class="k2">(</span><span class="n">1</span>, <span class="k1">sizeof</span><span class="k2">(</span>ALLEGRO_JOYSTICK_OSX<span class="k2">)</span><span class="k2">)</span><span class="k2">;</span>
<span class="number"> 20</span>      joy-&gt;product_id <span class="k3">=</span> product_id<span class="k2">;</span>
<span class="number"> 21</span>      ALLEGRO_JOYSTICK_OSX <span class="k3">*</span><span class="k3">*</span>back <span class="k3">=</span> _al_vector_alloc_back<span class="k2">(</span><span class="k3">&amp;</span>joysticks<span class="k2">)</span><span class="k2">;</span>
<span class="number"> 22</span>      <span class="k3">*</span>back <span class="k3">=</span> <a href="http://www.allegro.cc/manual/joy"><span class="a">joy</span></a><span class="k2">;</span>
<span class="number"> 23</span>   <span class="k2">}</span>
<span class="number"> 24</span>   joy-&gt;cfg_state <span class="k3">=</span> new_joystick_state<span class="k2">;</span>
<span class="number"> 25</span>
<span class="number"> 26</span>   CFArrayRef elements <span class="k3">=</span> IOHIDDeviceCopyMatchingElements<span class="k2">(</span>
<span class="number"> 27</span>      ref,
<span class="number"> 28</span>      NULL,
<span class="number"> 29</span>      kIOHIDOptionsTypeNone
<span class="number"> 30</span>   <span class="k2">)</span><span class="k2">;</span>
<span class="number"> 31</span>
<span class="number"> 32</span>   add_elements<span class="k2">(</span>elements, <a href="http://www.allegro.cc/manual/joy"><span class="a">joy</span></a><span class="k2">)</span><span class="k2">;</span>
<span class="number"> 33</span>
<span class="number"> 34</span>   CFRelease<span class="k2">(</span>elements<span class="k2">)</span><span class="k2">;</span>
<span class="number"> 35</span>
<span class="number"> 36</span>   <span class="c">// Fill in ALLEGRO_JOYSTICK properties</span>
<span class="number"> 37</span>   joy-&gt;parent.info.num_sticks <span class="k3">=</span> joy-&gt;num_x_axes<span class="k2">;</span>
<span class="number"> 38</span>   joy-&gt;parent.info.num_buttons <span class="k3">=</span> joy-&gt;num_buttons<span class="k2">;</span>
<span class="number"> 39</span>   <span class="k1">for</span> <span class="k2">(</span>i <span class="k3">=</span> <span class="n">0</span><span class="k2">;</span> i <span class="k3">&lt;</span> joy-&gt;num_x_axes<span class="k2">;</span> i<span class="k3">+</span><span class="k3">+</span><span class="k2">)</span> <span class="k2">{</span>
<span class="number"> 40</span>      <span class="k1">int</span> axes <span class="k3">=</span> <span class="n">1</span><span class="k2">;</span>
<span class="number"> 41</span>      <span class="k1">if</span> <span class="k2">(</span>joy-&gt;num_y_axes <span class="k3">&gt;</span><span class="k3">=</span> i<span class="k2">)</span>
<span class="number"> 42</span>         axes<span class="k3">+</span><span class="k3">+</span><span class="k2">;</span>
<span class="number"> 43</span>      <span class="k1">if</span> <span class="k2">(</span>joy-&gt;num_z_axes <span class="k3">&gt;</span><span class="k3">=</span> i<span class="k2">)</span>
<span class="number"> 44</span>         axes<span class="k3">+</span><span class="k3">+</span><span class="k2">;</span>
<span class="number"> 45</span>      joy-&gt;parent.info.stick<span class="k2">[</span>i<span class="k2">]</span>.num_axes <span class="k3">=</span> axes<span class="k2">;</span>
<span class="number"> 46</span>      <span class="k1">char</span> <span class="k3">*</span>buf <span class="k3">=</span> <a href="http://www.allegro.cc/manual/al_malloc"><span class="a">al_malloc</span></a><span class="k2">(</span><span class="n">20</span><span class="k2">)</span><span class="k2">;</span>
<span class="number"> 47</span>      <a href="http://www.delorie.com/djgpp/doc/libc/libc_737.html" target="_blank">sprintf</a><span class="k2">(</span>buf, <span class="s">"Stick %d"</span>, i<span class="k2">)</span><span class="k2">;</span>
<span class="number"> 48</span>      joy-&gt;parent.info.stick<span class="k2">[</span>i<span class="k2">]</span>.name <span class="k3">=</span> buf<span class="k2">;</span>
<span class="number"> 49</span>   <span class="k2">}</span>
<span class="number"> 50</span>
<span class="number"> 51</span>   <a href="http://www.allegro.cc/manual/al_unlock_mutex"><span class="a">al_unlock_mutex</span></a><span class="k2">(</span>add_mutex<span class="k2">)</span><span class="k2">;</span>
<span class="number"> 52</span>
<span class="number"> 53</span>   osx_joy_generate_configure_event<span class="k2">(</span><span class="k2">)</span><span class="k2">;</span>
<span class="number"> 54</span>
<span class="number"> 55</span>   ALLEGRO_INFO<span class="k2">(</span><span class="s">"Found joystick (%d buttons, %d %d %d axes)\n"</span>,
<span class="number"> 56</span>      joy-&gt;num_buttons, joy-&gt;num_x_axes, joy-&gt;num_y_axes, joy-&gt;num_z_axes<span class="k2">)</span><span class="k2">;</span>
<span class="number"> 57</span><span class="k2">}</span>
</div></div><p>
The highlighted line is the root of the infinite <span class="source-code"><span class="k1">do</span><span class="k3">/</span><span class="k1">while</span></span> loop. I think because both of my joysticks are the same model, they both have the same ID. The <span class="source-code">find_joystick<span class="k2">(</span><span class="k2">)</span></span> function scans the vector of existing joysticks to see if there is an ID match before adding a new joystick to the vector. Since the IDs are the same, the second joystick is never added to the vector. That&#39;s why this code never exits, since the vector never expands to match the number of joysticks stored in the <span class="source-code">count</span> variable:
</p><div class="source-code snippet"><div class="inner"><pre>   <span class="k1">do</span> <span class="k2">{</span>
      <a href="http://www.allegro.cc/manual/al_rest"><span class="a">al_rest</span></a><span class="k2">(</span><span class="n">0</span>.<span class="n">001</span><span class="k2">)</span><span class="k2">;</span>
      CFSetRef devices <span class="k3">=</span> IOHIDManagerCopyDevices<span class="k2">(</span>hidManagerRef<span class="k2">)</span><span class="k2">;</span>
      <span class="k1">if</span> <span class="k2">(</span>devices <span class="k3">=</span><span class="k3">=</span> nil<span class="k2">)</span> <span class="k2">{</span>
         <span class="k1">break</span><span class="k2">;</span>
      <span class="k2">}</span>
      count <span class="k3">=</span> CFSetGetCount<span class="k2">(</span>devices<span class="k2">)</span><span class="k2">;</span>
      CFRelease<span class="k2">(</span>devices<span class="k2">)</span><span class="k2">;</span>
      <a href="http://www.allegro.cc/manual/al_lock_mutex"><span class="a">al_lock_mutex</span></a><span class="k2">(</span>add_mutex<span class="k2">)</span><span class="k2">;</span>
      size <span class="k3">=</span> _al_vector_size<span class="k2">(</span><span class="k3">&amp;</span>joysticks<span class="k2">)</span><span class="k2">;</span>
      <a href="http://www.allegro.cc/manual/al_unlock_mutex"><span class="a">al_unlock_mutex</span></a><span class="k2">(</span>add_mutex<span class="k2">)</span><span class="k2">;</span>
   <span class="k2">}</span> <span class="k1">while</span> <span class="k2">(</span>size <span class="k3">&lt;</span> count<span class="k2">)</span><span class="k2">;</span>
</pre></div></div><p>
After a cursory look at the <a href="http://developer.apple.com/library/mac/#documentation/DeviceDrivers/Conceptual/HID/new_api_10_5/tn2187.html">Apple HID CLass Device Interface Guide</a> my guess is the <span class="source-code">IOHIDDeviceRef</span> needs to be used to distinguish between joysticks since the string ID can end up being identical for different devices.
</p></div>]]>
		</description>
		<author>no-reply@allegro.cc (Todd Cope)</author>
		<pubDate>Thu, 18 Aug 2011 07:37:55 +0000</pubDate>
	</item>
	<item>
		<description><![CDATA[<div class="mockup v2"><p>If IOHIDDeviceRef is unique it should work. Can you try it? I can try it out tomorrow too assuming my 360 controllers report the same product id (so I can see it fail before testing something that works.)
</p></div>]]>
		</description>
		<author>no-reply@allegro.cc (Trent Gamblin)</author>
		<pubDate>Thu, 18 Aug 2011 08:14:44 +0000</pubDate>
	</item>
	<item>
		<description><![CDATA[<div class="mockup v2"><p>I probably won&#39;t be able to do it until Saturday. If you don&#39;t get to it before then I&#39;ll try it.
</p></div>]]>
		</description>
		<author>no-reply@allegro.cc (Todd Cope)</author>
		<pubDate>Fri, 19 Aug 2011 02:10:41 +0000</pubDate>
	</item>
	<item>
		<description><![CDATA[<div class="mockup v2"><p>Do you have any short program that makes good use of dual joysticks? At least maybe you can confirm with your game if this patch works. What I&#39;ve tested is:</p><p>1) Before patch, ex_joystick_events hangs at black screen on startup<br />2) After patch, ex_joystick_events loads<br />3) Both joysticks manipulate the knobs and doohickeys in ex_joystick_events</p><p>The patch to hidjoy.m is attached.
</p></div>]]>
		</description>
		<author>no-reply@allegro.cc (Trent Gamblin)</author>
		<pubDate>Fri, 19 Aug 2011 05:24:37 +0000</pubDate>
	</item>
	<item>
		<description><![CDATA[<div class="mockup v2"><p>I applied your patch and the problem seems to be solved! ex_joystick_events works as you described. Both joysticks can now be used in my game. For good measure I hooked up a third (different) joystick and tried my game with all three and they all three were able to be used.
</p></div>]]>
		</description>
		<author>no-reply@allegro.cc (Todd Cope)</author>
		<pubDate>Fri, 19 Aug 2011 06:00:19 +0000</pubDate>
	</item>
	<item>
		<description><![CDATA[<div class="mockup v2"><p>Just to double check, you&#39;re getting 3 different sets of input right? Like controlling 3 characters separately? Most likely the case but just want to make sure.
</p></div>]]>
		</description>
		<author>no-reply@allegro.cc (Trent Gamblin)</author>
		<pubDate>Fri, 19 Aug 2011 06:05:03 +0000</pubDate>
	</item>
	<item>
		<description><![CDATA[<div class="mockup v2"><p>Yes. Everything is working perfectly now.
</p></div>]]>
		</description>
		<author>no-reply@allegro.cc (Todd Cope)</author>
		<pubDate>Fri, 19 Aug 2011 06:09:59 +0000</pubDate>
	</item>
	<item>
		<description><![CDATA[<div class="mockup v2"><p>Alright. Thanks for reporting. BTW I did use your suggestion of using the IOHIDDeviceRef as the id.
</p></div>]]>
		</description>
		<author>no-reply@allegro.cc (Trent Gamblin)</author>
		<pubDate>Fri, 19 Aug 2011 06:11:23 +0000</pubDate>
	</item>
	<item>
		<description><![CDATA[<div class="mockup v2"><p>Yeah, I saw it in the patch. Glad my idea worked <img src="http://www.allegro.cc/forums/smileys/smiley.gif" alt=":)" /> Thanks for fixing this.
</p></div>]]>
		</description>
		<author>no-reply@allegro.cc (Todd Cope)</author>
		<pubDate>Fri, 19 Aug 2011 06:15:07 +0000</pubDate>
	</item>
	<item>
		<description><![CDATA[<div class="mockup v2"><p>It&#39;s in SVN now.
</p></div>]]>
		</description>
		<author>no-reply@allegro.cc (Trent Gamblin)</author>
		<pubDate>Fri, 19 Aug 2011 06:17:02 +0000</pubDate>
	</item>
	<item>
		<description><![CDATA[<div class="mockup v2"><p>This makes me feel pretty inside! <img src="http://www.allegro.cc/forums/smileys/cheesy.gif" alt=":D" />
</p></div>]]>
		</description>
		<author>no-reply@allegro.cc (Arthur Kalliokoski)</author>
		<pubDate>Fri, 19 Aug 2011 06:20:21 +0000</pubDate>
	</item>
</rss>
