General OS information:

RELEASE=18 CODENAME=sarah EDITION="Cinnamon 64-bit" DESCRIPTION="Linux Mint 18 Sarah" DESKTOP=Gnome TOOLKIT=GTK NEW_FEATURES_URL=http://www.linuxmint.com/rel_sarah_cinnamon_whatsnew.php RELEASE_NOTES_URL=http://www.linuxmint.com/rel_sarah_cinnamon.php USER_GUIDE_URL=help:linuxmint GRUB_TITLE=Linux Mint 18 Cinnamon 64-bit

• Resolutions:
  • Monitor 1: 1920x1080
  • Monitor 2: 1920x1080
  • Monitor 3: 1920x1080 Python 3.6.5 |Anaconda, Inc.| (default, Apr 29 2018, 16:14:56)
• MSS version: 4.0.0

Description of the warning/error

I have tried to use mss to make screenshots from console code with python. Works just fine. Now I have made a GUI with PyQt5 and it is working just fine in windows. But in Linux, I get a segmentation fault

This is the smallest code that makes the error:

from PyQt5 import QtWidgets
from mss import mss

if __name__ == "__main__":
    import sys
    app = QtWidgets.QApplication(sys.argv)

    with mss() as sct:
        pass

I have made my code in PyCharm and I have realized that if I run the debugger without even any breakpoints, the code works. But if I RUN the code from within PyCharm it crashes with seg fault. The same thing if I run the program from a console.

I'm working on 10.12.1 MacOS Sierra with 2.0.18 mss version and python 3.5. When today I tried to create multiple screenshots using mss according to documentation. And with two different screens with resolutions {'height': 1200, 'left': 0, 'top': 0, 'width': 1920}, {'height': 768, 'left': -1366, 'top': 0, 'width': 1366}. The bigger screenshot looks fine but the smaller gives a very bad result: http://imgur.com/a/hKrHw. What is the cause of it?

The problem

Hello, I try to do stuff like this:

• Http request from JS
• Python handles it with Flask
• When Python Flask gets a request it will grab a current display view (screenshot), resize it, convert to base64 and return it as response

It's all ok, but when I send second http request - python mss fails.

(there's .js and .py files because it could somehow help)

server.py

# Image processing, FPS in console
import mss, cv2, base64, time
import numpy as np
from PIL import Image as i

# Get current frame of second monitor
def getFrame():
    start_time = time.perf_counter()

    # Get frame (only rgb - smaller size)
    frame_rgb     = mss.mss().grab(mss.mss().monitors[2]).rgb # type: bytes, len: 1280*720*3 (w, h, r, g, b)

    # Convert it from bytes to resize
    frame_image   = i.frombytes("RGB", (1280, 720), frame_rgb, "raw", "RGB") # PIL.Image.Image
    frame_array   = np.array(frame_image) # type: numpy.ndarray
    frame_resized = cv2.resize(frame_array, (640, 360), interpolation = cv2.INTER_CUBIC) # type: numpy.ndarray

    # Encode to base64 - prepared to send
    frame_base64  = base64.b64encode(frame_resized) # type: bytes, len: 640*360*4 (w, h, r, g, b, ???)

    print(f'{ round( 1 / (time.perf_counter() - start_time), 2) } fps')
    return frame_base64

# Flask request handler
from flask import Flask, request
from flask_cors import CORS

app = Flask(__name__)
cors = CORS(app)

@app.route('/frame_base64')
def frame_base64():
    return getFrame()

app.run(debug=True, port=7999)

script.js (little weird because of compilation from coffeescript)

(function() {

  $(document).ready(function() {

    return $.ajax({
      type: 'get',
      url: ' http://127.0.0.1:7999/frame_base64',
      success: (response) => {
        return console.log(response);
      }
    });

  });

}).call(this);

Full console log:

D:\web\projects\html-display-stream\backend>python server.py
 * Serving Flask app "server" (lazy loading)
 * Environment: production
   WARNING: This is a development server. Do not use it in a production deployment.
   Use a production WSGI server instead.
 * Debug mode: on
 * Restarting with stat
 * Debugger is active!
 * Debugger PIN: 258-577-249
 * Running on http://127.0.0.1:7999/ (Press CTRL+C to quit)
18.0 fps
127.0.0.1 - - [26/Feb/2020 00:36:05] "GET /frame_base64 HTTP/1.1" 200 -
127.0.0.1 - - [26/Feb/2020 00:36:06] "GET /frame_base64 HTTP/1.1" 500 -
Traceback (most recent call last):
  File "C:\Users\Roman\AppData\Local\Programs\Python\Python37\lib\site-packages\flask\app.py", line 2463, in __call__

    return self.wsgi_app(environ, start_response)
  File "C:\Users\Roman\AppData\Local\Programs\Python\Python37\lib\site-packages\flask\app.py", line 2449, in wsgi_app

    response = self.handle_exception(e)
  File "C:\Users\Roman\AppData\Local\Programs\Python\Python37\lib\site-packages\flask_cors\extension.py", line 161, in wrapped_function
    return cors_after_request(app.make_response(f(*args, **kwargs)))
  File "C:\Users\Roman\AppData\Local\Programs\Python\Python37\lib\site-packages\flask\app.py", line 1866, in handle_exception
    reraise(exc_type, exc_value, tb)
  File "C:\Users\Roman\AppData\Local\Programs\Python\Python37\lib\site-packages\flask\_compat.py", line 39, in reraise
    raise value
  File "C:\Users\Roman\AppData\Local\Programs\Python\Python37\lib\site-packages\flask\app.py", line 2446, in wsgi_app

    response = self.full_dispatch_request()
  File "C:\Users\Roman\AppData\Local\Programs\Python\Python37\lib\site-packages\flask\app.py", line 1951, in full_dispatch_request
    rv = self.handle_user_exception(e)
  File "C:\Users\Roman\AppData\Local\Programs\Python\Python37\lib\site-packages\flask_cors\extension.py", line 161, in wrapped_function
    return cors_after_request(app.make_response(f(*args, **kwargs)))
  File "C:\Users\Roman\AppData\Local\Programs\Python\Python37\lib\site-packages\flask\app.py", line 1820, in handle_user_exception
    reraise(exc_type, exc_value, tb)
  File "C:\Users\Roman\AppData\Local\Programs\Python\Python37\lib\site-packages\flask\_compat.py", line 39, in reraise
    raise value
  File "C:\Users\Roman\AppData\Local\Programs\Python\Python37\lib\site-packages\flask\app.py", line 1949, in full_dispatch_request
    rv = self.dispatch_request()
  File "C:\Users\Roman\AppData\Local\Programs\Python\Python37\lib\site-packages\flask\app.py", line 1935, in dispatch_request
    return self.view_functions[rule.endpoint](**req.view_args)
  File "D:\web\projects\html-display-stream\backend\server.py", line 33, in frame_base64
    return getFrame()
  File "D:\web\projects\html-display-stream\backend\server.py", line 11, in getFrame
    frame_rgb     = mss.mss().grab(mss.mss().monitors[2]).rgb # type: bytes, len: 1280*720*3 (w, h, r, g, b)
  File "C:\Users\Roman\AppData\Local\Programs\Python\Python37\lib\site-packages\mss\windows.py", line 291, in grab
    raise ScreenShotError("gdi32.GetDIBits() failed.")
mss.exception.ScreenShotError: gdi32.GetDIBits() failed.

Additional info:

Windows 7 x64 Service Pack 1 Monitors: 1920×1080, 1280×720 Python 3.7.6 pip 20.0.2 python-mss last version of now

P.S.: Sorry for my bad English.

Thanks

General informations:

• OS name: macOS
• OS version: 10.13.1 "High Sierra"
• OS architecture: 64 bits
• Monitor(s)'s resolution: 2880x1800, default system scaling/resolution
• Result of the command python --version: Python 2.7.10, however python3 --version yields Python 3.6.2 (which is what was used.)

Description of the warning/error

The content of mss().monitors is incorrect:

from mss import mss
mss().monitors

returns [{'left': 0, 'top': 0, 'width': 1680, 'height': 1050}, {'left': 0, 'top': 0, 'width': 1680, 'height': 1050}]

Full message

N/A

Other details

So far this is the only computer I've tested this on that has this issue, and it's the only hi-DPI computer I own.

General informations:

• OS name: macOS
• OS version: 10.12.5 "Sierra"
• OS architecture: 64 bits
• Result of the command python --version: Python 2.7.10, however python3 --version yields Python 3.6.2 (which is what was used.)

For GNU/Linux users:

• Desktop Environment: Quartz

Description of the warning/error

Putting and removing images captured using MSS in a queue results in a massive memory usage. This example code resulted in about 6GB used in less that 15 seconds.

from mss import mss
import time
import queue

myqueue = queue.Queue()

while True:
    with mss() as sct:
        myqueue.put(sct.shot())
    time.sleep(0.25)
    print(myqueue.get())

Full message

N/A

Other details

Willing to provide more info as needed!

General information:

• OS name: Windows 10
• OS version: 10.0.17134.523
• OS architecture: x64
• Resolutions:
  • Monitor 1: 1600x900
  • Monitor 2: 1920x1080
• Python version: 3.7.0
• MSS version: 4.0.1

The combined monitor image is rendering incorrectly and (because?) the monitors property returns invalid results.

If you look at my output from print(sct.monitors) you will see the results are impossible:

[{'left': 0, 'top': -172, 'width': 3520, 'height': 1252}, {'left': 0, 'top': 0, 'width': 1600, 'height': 900}, {'left': 1600, 'top': -172, 'width': 1920, 'height': 1080}]

If I understand correctly, this output is saying that monitor 2 lies outside of the combination of all monitors together, which of course is impossible. I think this is what causes the 172-pixel black bar along the bottom of the image.

I think the correct output of mss().monitors should be:

[{'left': 0, 'top': 0, 'width': 3520, 'height': 1080}, {'left': 0, 'top': 172, 'width': 1600, 'height': 900}, {'left': 1600, 'top': 0, 'width': 1920, 'height': 1080}]

here is a screenshot of my monitor position in windows display manager:

General information:

• OS name: _Debian GNU/Linux_Ubuntu
• OS version: 18.10
• OS architecture: 64 bits
• Resolutions:
  • Monitor 1: 1920x1080
  • Monitor 2: 1920x1080
• Python version: 3.7.1
• MSS version: 4.0.2

For GNU/Linux users:

• Display server protocol and version, if known: X server wayland
• Desktop Environment: Unity
• Composite Window Manager name and version: [not sure, it's gonna be whatever ubuntu 18.10 uses by default - I haven't configured any of this stuff]

Description of the warning/error

When I use any screen capture command (grab(), shot()), I get an error that XGetImage failed. code: pipenv install mss

and in file process.py, I have taken some code straight the examples in documentation:

import mss
with mss.mss() as sct:
    try:
        filename = sct.shot(mon=-1, output='fullscreen.png')
        print(filename)
    except Exception as e:
        print(e, "\n", e.details)

The above code outputs this:

XGetImage() failed
 {'retval': <mss.linux.LP_XImage object at 0x7fc72d567bf8>, 'args': (<mss.linux.LP_Display object at 0x7fc72db7d1e0>, <mss.linux.LP_Display object at 0x7fc72d567950>, 0, 0, 1920, 1080, 16777215, 2)}

And the stracktrace looks like this:

Traceback (most recent call last):
  File "process.py", line 3, in <module>
    filename = sct.shot(mon=-1, output='fullscreen.png')
  File "/home/f41lurizer/.local/share/virtualenvs/poker-TAtsjijf/lib/python3.7/site-packages/mss/base.py", line 140, in shot
    return next(self.save(**kwargs))
  File "/home/f41lurizer/.local/share/virtualenvs/poker-TAtsjijf/lib/python3.7/site-packages/mss/base.py", line 129, in save
    sct = self.grab(monitor)
  File "/home/f41lurizer/.local/share/virtualenvs/poker-TAtsjijf/lib/python3.7/site-packages/mss/linux.py", line 430, in grab
    ZPIXMAP,
  File "/home/f41lurizer/.local/share/virtualenvs/poker-TAtsjijf/lib/python3.7/site-packages/mss/linux.py", line 171, in validate
    raise ScreenShotError(err, details=details)
mss.exception.ScreenShotError: XGetImage() failed

Other details

I have also tried running as root, and running outside of tmux. Neither of these things changed the error I'm getting. I wonder if this has something to do with using wayland? On pyscreenshot, they seem to have limited support for screenshots on wayland.

General information:

• OS name: Windows
• OS version: 10, version 1803
• OS architecture: 64-bit
• Resolutions:
  • Monitor 1: 1920x1080
  • Monitor 2: 1920x1080
• Python version: 3.6.5
• MSS version: 3.2.1

Description of the warning/error

MSS consistently throws the following error, always after my program has been running for a little over 3 hours, and after successfully capturing many (22,000+) screenshots in that time.

Full message

== 2018-07-15 07:17:17.953381 runtime: 3:09:39.428722 ==
('gdi32.GetDIBits() failed.', {'bits': 0, 'height': 665, 'width': 1033, 'gdi': <WinDLL 'gdi32', handle 7ffeff9b0000 at 0x1e9c1896898>, 'monitor': {'left': -1034, 'top': 31, 'width': 1033, 'height': 665}, 'self': <mss.windows.MSS object at 0x000001E9C1896860>})
Traceback (most recent call last):
  File "D:\IdeaProjects\Python\CaptureTest\main.py", line 98, in <module>
    run()
  File "D:\IdeaProjects\Python\CaptureTest\main.py", line 82, in run
    self.screenshot()
  File "D:\IdeaProjects\Python\CaptureTest\main.py", line 77, in screenshot
    self.im = self.window.screenshot()
  File "D:\IdeaProjects\Python\CaptureTest\main.py", line 84, in screenshot
    im = self.mss_instance.grab(area)
  File "C:\Users\Nick\AppData\Local\Programs\Python\Python36\lib\site-packages\mss\windows.py", line 202, in grab
    del self._data
AttributeError: _data

Other details

I've tried to replicate this error by simply calling mss.grab(...) in a while loop and seeing if it breaks after x number of screenshots, but that runs fine for at least 160,000 iterations, so I can't figure out why my program consistently seems to break at ~3 hours runtime.

Upon viewing the MSS source, I realised that the del self._data line is directly followed by raise ScreenShotError('gdi32.GetDIBits() failed.', locals()), so I suppose my question is:

What could cause gdi32.GetDIBits() to spontaneously fail?

from time import time
import mss
import mss.tools

start = time()
count = 1

while True:
	with mss.mss() as sct:
	    # The screen part to capture
	    monitor = {'top': 144, 'left': 80, 'width': 1397, 'height': 782}
	    output = 'frames/sct-{}.png'.format(count)
	    count += 1
	    # Grab the data
	    sct_img = sct.grab(monitor)

	    # Save to the picture file
	    mss.tools.to_png(sct_img.rgb, sct_img.size, output)
	    # print(output)
	    now = time()
	    if (now - start) % 60 >= 10: break

This seems to save only around 100 frames for 10 seconds. Can this be improved?

Changes proposed in this PR

• Fixes #57

Apologies on the following items - but I suspect this PR does not make any changes that impact them :)

It is very important to keep up to date tests and documentation.

• [ ] Tests added/updated
• [ ] Documentation updated

Is your code right?

• [ ✔️ ] PEP8 compliant
• [ ✔️ ] flake8 passed (bonus)
• [ ✔️ ] pylint passed (bonus)

shouldn't there by a try/except around the objects created and clean-up? otherwise if an exception happens between the two the objects will leak, and object leaks are not good on windows :)

General information:

• OS name: MacOS
• OS version: 13.0.1
• OS architecture: ARM
• Resolutions:
  • Monitor 1: 2560 x 1664
• Python version: 3.9.15
• MSS version: 7.0.1

Description of the warning/error

Colors get washed out when taking monitor captures

Full message

Running the numpy / opencv sample code from the documentation and noticed that the color gets extremely washed out. The macbook I am running this on has a 10-bit panel. Perhaps some of this information could be getting lost, but I am not quite sure.

Code Used

import cv2
import numpy

import mss
import time
with mss.mss() as sct:
    # Part of the screen to capture
    monitor = {"top": 40, "left": 0, "width": 800, "height": 640}

    while "Screen capturing":
        last_time = time.time()

        # Get raw pixels from the screen, save it to a Numpy array
        img = numpy.array(sct.grab(monitor))

        # Display the picture
        cv2.imshow("OpenCV/Numpy normal", img)

        # Display the picture in grayscale
        # cv2.imshow('OpenCV/Numpy grayscale',
        #            cv2.cvtColor(img, cv2.COLOR_BGRA2GRAY))

        print(f"fps: {1 / (time.time() - last_time)}")

        # Press "q" to quit
        if cv2.waitKey(25) & 0xFF == ord("q"):
            cv2.destroyAllWindows()
            break

General information:

• OS name: Ubuntu Linux
• OS version: 22.04
• OS architecture: 64 bits
• Resolutions:
  • Monitor 1: 3440x1440 (issue occurs at all resolutions)
• Python version: 3.10.6
• MSS version: 6.1.0 & 7.0.1

For GNU/Linux users:

• Display server protocol and version, if known: X11 server
• Desktop Environment: ubuntu:GNOME
• Composite Window Manager name and version: X.Org v: 1.21.1.3, compositor: gnome-shell v: 42.5

Description of the warning/error

--- The issue (and solution) is described in detail here ---

In summary, the following error occurs when trying to instantiate an mss object after opening/closing a Tkinter Toplevel window. This error does not occur on Windows.

Full message

  File "/home/my_project/src/utilities/geometry.py", line 64, in screenshot
    with mss.mss() as sct:
  File "/home/my_project/env/lib/python3.10/site-packages/mss/factory.py", line 34, in mss
    return linux.MSS(**kwargs)
  File "/home/my_project/env/lib/python3.10/site-packages/mss/linux.py", line 297, in __init__
    self.root = self.xlib.XDefaultRootWindow(self._get_display(display))
  File "/home/my_project/env/lib/python3.10/site-packages/mss/linux.py", line 184, in validate
    raise ScreenShotError(f"{func.__name__}() failed", details=details)
mss.exception.ScreenShotError: XDefaultRootWindow() failed

Screenshot error: XDefaultRootWindow() failed, {'retval': <mss.linux.LP_XWindowAttributes object at 0x7f31d8d38ac0>, 
    'args': (<mss.linux.LP_Display object at 0x7f31d8d38740>,)}

Other details

The following code can be used to reproduce the error. Simply run this program and use the GUI button to open a new window that allows you to take a screenshot - then close the pop-up window and attempt to repeat the process.

import tkinter as tk

import mss
import mss.tools


def take_screenshot():
   with mss.mss() as sct:
       screen_part = {"top": 370, "left": 1090, "width": 80, "height": 390}
       sct_img = sct.grab(screen_part)
       mss.tools.to_png(sct_img.rgb, sct_img.size, output="./output.png")

def create_top_level_win():
   top_level_win = tk.Toplevel(root)

   take_screenshot_btn = tk.Button(top_level_win, text="Take screenshot", command=take_screenshot)
   take_screenshot_btn.pack()

root = tk.Tk()

btn = tk.Button(root, text="Open TopLevel", command=create_top_level_win)
btn.pack()

root.mainloop()

A temporary workaround is to reuse a single mss object throughout the application, like so:

sct = mss.mss()

def take_screenshot():
    global sct
    screen_part = {"top": 370, "left": 1090, "width": 80, "height": 390}
    sct_img = sct.grab(screen_part)
    mss.tools.to_png(sct_img.rgb, sct_img.size, output="./output.png")

On StackOverflow, one answer suggests that the bug is due to "the current implementation of MSS changing the current X11 error handler and leaving it afterwards, which causes a conflict with Tcl/Tk (the backend of Python Tkinter), see here for details"

General information:

• OS name: _Windows11

• OS version: sid

• OS architecture: 64 bits

• Resolutions:

  • Monitor 1: 3840x2160 DPI 200%
  • Monitor 2: 2560x1440 DPI 175%

• Python version: 3.10.9

• MSS version: 3.2.0

  mss_scr = mss.mss() print(mss_scr.monitors)

[{'left': -2926, 'top': 0, 'width': 6766, 'height': 2160}, {'left': 0, 'top': 0, 'width': 3840, 'height': 2160}, {'left': -2926, 'top': 0, 'width': 2926, 'height': 1646}] <===== It is actually 2560*1440

Pull Request #211 refactored by Sourcery.

Since the original Pull Request was opened as a fork in a contributor's repository, we are unable to create a Pull Request branching from it.

To incorporate these changes, you can either:

1. Merge this Pull Request instead of the original, or

2. Ask your contributor to locally incorporate these commits and push them to the original Pull Request

   Incorporate changes via command line

   git fetch https://github.com/BoboTiG/python-mss pull/211/head
   git merge --ff-only FETCH_HEAD
   git push

NOTE: As code is pushed to the original Pull Request, Sourcery will re-run and update (force-push) this Pull Request with new refactorings as necessary. If Sourcery finds no refactorings at any point, this Pull Request will be closed automatically.

See our documentation here.

Help us improve this pull request!

General information:

• OS name: Windows 10
• OS architecture: 64 bits
• Resolutions:
  • Monitor 1: 1920x1080
• Python version: 3.11
• MSS version: newest

Full message

Rather a question would be nice if I got some help 

General information:

• OS name: Windows 10 Pro
• OS version: 19043.1889/21H1
• OS architecture: 64 bits
• Resolutions:
  • Monitor 1: 3840x2160 60Hz
  • Monitor 2: 1920x1080 60Hz
• Python version: 3.7.0
• MSS version: 6.1.0
• Videocard: Gigabyte 3080ti
• CPU: AMD Ryzen 7 5800x

Description

I try to use MSS library to capture screen game on my Windows PC, however capture frame rates are not getting higher than 60FPS. Although game is running on 160 FPS, MSS is limited to only 60.

I tried:

1. Changing Monitor Framerate to 30 and mss fps also dropped to 30.
2. Changing Monitor resolution, nothing changed
3. Changing size of screen capture (Region of Interest), it did not change FPS

So I suspect, the problem is not Hardware related and limitation comes from software.

Code

    width = 512 # roi
    height = 512  # roi
    mon = {
        # "left": int(3840 / 2 - width / 2),
        # "top": int(2160 / 2 - height / 2),
        "left": int(1920 / 2 - width / 2),
        "top": int(1080 / 2 - height / 2),
        "width": width,
        "height": height,
    }

    sct = mss()
    fps = [i for i in range(30)]
    index = 0
    prev_bytes = None
    while True:
        if (
            not disabed_capture
        ):
            start_time = time.time()
            _bytes = sct.grab(mon)
            if prev_bytes is not None and _bytes == prev_bytes:
                print("SAME!")
                continue
            prev_bytes = _bytes
            frame = np.array(_bytes)
            queue.put([time.time(), frame])
            index = (index + 1) % len(fps)
            fps[index] = 1 / (time.time() - start_time)
            if index % 30 == 0:
                print("SCREENSHOT FPS: ", sum(fps) / len(fps))