Add support table

BoboTiG · BoboTiG · commit 843e903ec664 · 2015-04-15T15:09:43.000+02:00
diff --git a/README.rst b/README.rst
@@ -4,13 +4,39 @@ A cross-platform multi-screen shot module in pure python using ctypes
 
 Very basic, it will grab one screen shot by monitor or a screen shot of all monitors and save it to a PNG file, Python 2.6/3.5 compatible & PEP8 compliant.
 
-So, while you can `pip install --upgrade mss`, you may just drop it in your project and forget about it.
-
-MSS stands for Multi-Screen Shot.
+MSS stands for Multiple ScreenShots.
 
 It's under zlib licence.
 
 
+Installation
+============
+
+You can install it with pip::
+
+    pip install --upgrade mss
+
+Or you may just drop it in your project and forget about it.
+
+Support
+-------
+
+=========  =========  ========  =======
+Python     GNU/linux  Mac OS X  Windows
+=========  =========  ========  =======
+3.5.0a3    True       True      True
+**3.4.3**  **True**   **True**  **True**
+3.3.6      True       True      True
+3.2.6      True       True      True
+3.1.5      True       True      True
+3.0.1      True       True      True
+**2.7.9**  **True**   **True**  **True**
+2.6.9      True       True      True
+=========  =========  ========  =======
+
+Feel free to try MSS on a system we had not tested, and let report us by creating an [issue](https://github.com/BoboTiG/python-mss/issues).
+
+
 Testing
 =======
 
@@ -22,35 +48,29 @@ You can try the MSS module directly from the console::
 Instance the good class
 =======================
 
-You can determine automatically which class to use::
-
-    from platform import system
-    import mss
+So MSS can be used as simply as::
 
-    systems = {
-        'Darwin': mss.MSSMac,
-        'Linux': mss.MSSLinux,
-        'Windows': mss.MSSWindows
-        }
-    mss_class = systems[system()]()
+    from mss import mss
+    screenshotter = mss()
 
-Or simply import the good one::
+Or import the good one::
 
-    from mss import MSSLinux as mss_class
+    from mss import MSSLinux as mss
+    screenshotter = mss()
 
 
 save(output, screen, callback)
 ------------------------------
 
-For each monitor, grab a screen shot and save it to a file.
+For each monitor, grab a screenshot and save it to a file.
 
 Parameters::
 
     output - string - the output filename. It can contain '%d' which
                       will be replaced by the monitor number.
-    screen - integer - grab one screen shot of all monitors (screen=-1)
-                       grab one screen shot by monitor (screen=0)
-                       grab the screen shot of the monitor N (screen=N)
+    screen - integer - grab one screenshot of all monitors (screen=-1)
+                       grab one screenshot by monitor (screen=0)
+                       grab the screenshot of the monitor N (screen=N)
     callback - function - in case where output already exists, call
                           the defined callback function with output
                           as parameter. If it returns True, then
@@ -63,21 +83,21 @@ This is a generator which returns created files.
 Examples
 ========
 
-One screen shot per monitor::
+One screenshot per monitor::
 
-    for filename in mss.save():
+    for filename in screenshotter.save():
         print(filename)
 
-Screen shot of the monitor 1::
+Screenshot of the monitor 1::
 
-    for filename in mss.save(screen=1):
+    for filename in screenshotter.save(screen=1):
         print(filename)
 
-Screen shot of the monitor 1, with callback::
+Screenshot of the monitor 1, with callback::
 
     def on_exists(fname):
         ''' Callback example when we try to overwrite an existing
-            screen shot.
+            screenshot.
         '''
         from os import rename
         from os.path import isfile
@@ -87,10 +107,10 @@ Screen shot of the monitor 1, with callback::
             rename(fname, newfile)
         return True
 
-    for filename in mss.save(screen=1, callback=on_exists):
+    for filename in screenshotter.save(screen=1, callback=on_exists):
         print(filename)
 
-A shot to grab them all (fullscreen shot)::
+A screenshot to grab them all::
 
-    for filename in mss.save(output='fullscreen-shot.png', screen=-1):
+    for filename in screenshotter.save(output='fullscreen-shot.png', screen=-1):
         print(filename)
diff --git a/doc/TESTING b/doc/TESTING
@@ -1,4 +1,4 @@
-The current MSS version was succesfully tested on these Python version.
+The current MSS version was successfully tested on these Python version.
 You have another version to add or a patch to support a new one? Let us know, open a pull-request on GitHub :)
 
 Python:
@@ -13,7 +13,7 @@ Python:
 
 
 ---
-The current MSS version was succesfully tested on these OS.
+The current MSS version was successfully tested on these OS.
 You have another OS to add? Let us know, open a ticket on GitHub :)
 
 GNU/Linux:
@@ -27,6 +27,8 @@ GNU/Linux:
 Mac OS X:
 	OS X 10.7 (Lion)
 	OS X 10.8 (Mountain Lion)
+	OS X 10.9 (Mavericks)
+	OS X 10.10 (Yosemite)
 
 Microsoft Windows:
 	Windows XP
diff --git a/mss.py b/mss.py
@@ -1,6 +1,6 @@
 #!/usr/bin/env python
 # coding: utf-8
-''' A cross-platform multi-screen shot module in pure python using ctypes.
+''' A cross-platform multiple screenshots module in pure python using ctypes.
 
     This module is maintained by Mickaël Schoentgen <mickael@jmsinfo.co>.
 
@@ -125,15 +125,18 @@ def debug(self, method='', scalar=None, value=None):
                 print('{0}() {1} {2} {3}'.format(method, scalar,
                                                  type(value).__name__, value))
 
-    def enum_display_monitors(self):
-        ''' Get positions of all monitors.
+    def enum_display_monitors(self, screen=0):
+        ''' Get positions of one or more monitors.
 
-            If self.oneshot is True, this function has to return a dict
-            with dimensions of all monitors at the same time.
-            If the monitor has rotation, you have to deal with inside
-            this method.
+            If the monitor has rotation, you have to deal with it
+            inside this method.
+
+            Parameters:
+             - screen - int - grab one screenshot of all monitors (screen=-1)
+                              grab one screenshot by monitor (screen=0)
+                              grab the screenshot of the monitor N (screen=N)
 
-            Must returns a dict with:
+            Returns a dict:
             {
                 'left':   the x-coordinate of the upper-left corner,
                 'top':    the y-coordinate of the upper-left corner,
@@ -143,33 +146,33 @@ def enum_display_monitors(self):
         '''
         raise NotImplementedError('MSS: subclasses need to implement this!')
 
-    def get_pixels(self, monitor_infos):
+    def get_pixels(self, monitor):
         ''' Retrieve screen pixels for a given monitor.
 
-            monitor_infos should contain at least:
+            `monitor` is a dict with:
             {
                 'left':   the x-coordinate of the upper-left corner,
                 'top':    the y-coordinate of the upper-left corner,
                 'width':  the width,
                 'heigth': the height
             }
 
-            Returns a dict with pixels.
+            Returns a dict of pixels.
         '''
         raise NotImplementedError('MSS: subclasses need to implement this!')
 
     def save(self,
              output='screenshot-%d.png',
              screen=0,
              callback=lambda *x: True):
-        ''' For each monitor, grab a screen shot and save it to a file.
+        ''' Grab a screenshot and save it to a file.
 
             Parameters:
              - output - string - the output filename. It can contain '%d' which
                                  will be replaced by the monitor number.
-             - screen - int - grab one screen shot of all monitors (screen=-1)
-                              grab one screen shot by monitor (screen=0)
-                              grab the screen shot of the monitor N (screen=N)
+             - screen - int - grab one screenshot of all monitors (screen=-1)
+                              grab one screenshot by monitor (screen=0)
+                              grab the screenshot of the monitor N (screen=N)
              - callback - function - in case where output already exists, call
                                      the defined callback function with output
                                      as parameter. If it returns True, then
@@ -240,7 +243,7 @@ def save_img(self, data, width, height, output):
 
 
 class MSSMac(MSS):
-    ''' Mutli-screen shot implementation for Mac OSX.
+    ''' Mutliple ScreenShots implementation for Mac OS X.
         It uses intensively the Quartz.
     '''
 
@@ -323,7 +326,7 @@ def save_img(self, data, width, height, output):
 
 
 class MSSLinux(MSS):
-    ''' Mutli-screen shot implementation for GNU/Linux.
+    ''' Mutliple ScreenShots implementation for GNU/Linux.
         It uses intensively the Xlib and Xrandr.
     '''
 
@@ -487,33 +490,41 @@ def get_pixels(self, monitor):
         if not ximage:
             raise ScreenshotError('MSS: XGetImage() failed.')
 
+        from ctypes import c_ubyte, c_char
+        bpl = ximage.contents.bytes_per_line
+        data = cast(ximage.contents.data, POINTER(width * height * c_ubyte)).contents
+
         # @TODO: this part takes most of the time. Need a better solution.
         def pix(pixel, _resultats={}, b=pack):
             ''' Apply shifts to a pixel to get the RGB values.
                 This method uses of memoization.
             '''
             if pixel not in _resultats:
-                _resultats[pixel] = b(b'<B', (pixel & rmask) >> 16) + \
-                    b(b'<B', (pixel & gmask) >> 8) + b(b'<B', pixel & bmask)
+                _resultats[pixel] = b(b'<B', pixel >> 24) + \
+                    b(b'<B', pixel>> 16) + b(b'<B', pixel)
             return _resultats[pixel]
 
         # http://cgit.freedesktop.org/xorg/lib/libX11/tree/src/ImUtil.c#n444
-        get_pix = self.xlib.XGetPixel
+        #~ get_pix = self.xlib.XGetPixel
+        #~ def get_pix(x, y):
+
         rmask = ximage.contents.red_mask
         gmask = ximage.contents.green_mask
         bmask = ximage.contents.blue_mask
+        bpl = ximage.contents.bytes_per_line
         self.debug('get_pixels', 'rmask', rmask)
         self.debug('get_pixels', 'gmask', gmask)
         self.debug('get_pixels', 'bmask', bmask)
-        pixels = [pix(get_pix(ximage, x, y))
-                  for y in range(height) for x in range(width)]
+        xrange = getattr(__builtins__, 'xrange', range)
+        pixels = [pix(data[idx])
+                  for idx in xrange(0, (width * height) - 2, 3)]
         self.xlib.XDestroyImage(ximage)
         self.image = b''.join(pixels)
         return self.image
 
 
 class MSSWindows(MSS):
-    ''' Mutli-screen shot implementation for Microsoft Windows. '''
+    ''' Mutliple ScreenShots implementation for Microsoft Windows. '''
 
     def __init__(self):
         ''' Windows initialisations. '''
@@ -671,7 +682,7 @@ def main():
 
     def on_exists(fname):
         ''' Callback example when we try to overwrite an existing
-            screen shot.
+            screenshot.
         '''
         from os import rename
         from os.path import isfile
diff --git a/setup.py b/setup.py
@@ -17,7 +17,7 @@
     author='Tiger-222',
     py_modules=['mss'],
     author_email='mickael@jmsinfo.co',
-    description='A cross-platform multi-screen shot module in pure python using ctypes',
+    description='A cross-platform multiple screenshots module in pure python using ctypes',
     long_description=open('README.rst').read(),
     classifiers=[
         'Development Status :: 5 - Production/Stable',
