Add functions to set DVDCSS_VERBOSE and DVDCSS_METHOD

Author: rlaphoenix

HISTORY.md

@@ -4,6 +4,13 @@
 
 N/A
 
+## 1.0.6
+
+**Improvements**
+
+- Add functions to set DVDCSS_VERBOSE and DVDCSS_METHOD environment variables.
+- Reset DVDCSS_VERBOSE and DVDCSS_METHOD on dispose.
+
 ## 1.0.5
 
 **Bugfixes**

README.md

@@ -32,15 +32,15 @@
       # check if dvd is scrambled
       if dvdcss.is_scrambled():
         print("The DVD is scrambled!")
-      
+
       # read volume id from sector 16
       dvdcss.seek(16)       # seek to sector 16
       dvdcss.read(1)        # read only one sector
       data = dvdcss.buffer  # access the latest read data
       volume_label = data[40:72].strip().decode()
       print(f"{dev}: {volume_label}")
       # >> eg. `'/dev/sr0: THE_IT_CROWD_DISC_1'`
-    
+
     # make sure you dispose when your done if you didn't
     # use `with`, otherwise stuff will get stuck in memory.
     # usage of `with` on pydvdcss automatically handles disposing.
@@ -103,28 +103,28 @@ or
     cd pydvdcss
     python -m pip install --user .
 
-*Note: with the second method you will need to handle updating yourself by re-cloning and installing it again.*
+_Note: with the second method you will need to handle updating yourself by re-cloning and installing it again._
 
 <p>&nbsp;</p><p>&nbsp;</p>
 
 # To-do
 
-- [X] Implement dvdcss_open
-- [X] Implement dvdcss_close
-- [X] Implement dvdcss_seek
-- [X] Implement dvdcss_read
-- [X] Implement dvdcss_error
-- [X] Implement dvdcss_is_scrambled
-- [X] Implement `__enter__` and `__exit__` for proper disposing
-- [X] Add handlers for failed find_library calls
-- [X] Add instructions for installing libdvdcss
-- [X] Add and test support for Windows
-- [X] Add and test support for Mac OS
-- [X] Add and test support for Linux
-- [ ] Implement dvdcss_readv
-- [ ] Add handlers for failed cdll calls
-- [ ] Add function to set DVDCSS_VERBOSE
-- [ ] Add function to set DVDCSS_METHOD
+- [x] Implement dvdcss_open
+- [x] Implement dvdcss_close
+- [x] Implement dvdcss_seek
+- [x] Implement dvdcss_read
+- [x] Implement dvdcss_error
+- [x] Implement dvdcss_is_scrambled
+- [x] Implement `__enter__` and `__exit__` for proper disposing
+- [x] Add handlers for failed find_library calls
+- [x] Add instructions for installing libdvdcss
+- [x] Add and test support for Windows
+- [x] Add and test support for Mac OS
+- [x] Add and test support for Linux
+- [x] Add function to set DVDCSS_VERBOSE
+- [x] Add function to set DVDCSS_METHOD
+- [ ] Implement dvdcss_readv, not sure how this would be used or implemented
+- [ ] Handle errors for failed cdll calls if any?
 
 <p>&nbsp;</p><p>&nbsp;</p>
 
@@ -161,10 +161,10 @@ happened.
 Tips:
 
 > Use SEEK_MPEG flag when seeking throughout VOB data sectors. It isn't needed
-  on the first sector.
+> on the first sector.
 
-> Use SEEK_KEY flag the first time you enter a TITLE. You *can* always call it
-  in VOB data sectors, however it will be unnecessary and cause slowdowns.
+> Use SEEK_KEY flag the first time you enter a TITLE. You _can_ always call it
+> in VOB data sectors, however it will be unnecessary and cause slowdowns.
 
 - **i_blocks**: absolute block offset to seek to.
 - **i_flags**: NOFLAGS by default, or you can specify SEEK_KEY or SEEK_MPEG flags.
@@ -214,4 +214,4 @@ Returns True if it's scrambled.
 
 ## [CONTRIBUTORS](https://github.com/rlaPHOENiX/pydvdcss/graphs/contributors)
 
-</span>
+</span>

pydvdcss/__init__.py

@@ -1,5 +1,6 @@
 import ctypes, ctypes.util
 import platform
+import os
 
 
 class PyDvdCss:
@@ -129,6 +130,9 @@ def dispose(self):
         self.buffer_len = 0
         if self.handle:
             self.close()
+        # reset verbosity and cracking mode environment variables
+        self.set_verbosity(None)
+        self.set_cracking_mode(None)
 
     def open(self, psz_target):
         """
@@ -214,3 +218,49 @@ def is_scrambled(self):
         Check if the DVD is scrambled.
         """
         return self._is_scrambled(self.handle) == 1
+    
+    def set_verbosity(self, verbosity=0):
+        """
+        Set libdvdcss's verbosity (DVDCSS_VERBOSE environment variable).
+
+        Available options are int 0..2
+          None: Unset/Remove/Reset the cracking mode.
+          0:    no error messages, no debug messages (this is the default)
+          1:    only error messages
+          2:    error and debug messages
+        
+        Returns the now current value of DVDCSS_VERBOSE, expected value should be
+        the same as the verbosity int provided.
+        """
+        if verbosity is None:
+            os.unsetenv("DVDCSS_VERBOSE")
+            return None
+        os.environ["DVDCSS_VERBOSE"] = str(verbosity)
+        return os.environ["DVDCSS_VERBOSE"]
+    
+    def set_cracking_mode(self, mode="key"):
+        """
+        Set libdvdcss's cracking mode (DVDCSS_METHOD environment variable).
+
+        Available options:
+          None:    Unset/Remove/Reset the cracking mode.
+          'title': By default the decrypted title key is guessed from the encrypted
+                   sectors of the stream. Thus it should work with a file as well as
+                   the DVD device. But decrypting a title key may take too much time
+                   or even fail. With the title method, the key is only checked at
+                   the beginning of each title, so it will not work if the key
+                   changes in the middle of a title.
+          'disc':  The disc key is cracked first. Afterwards all title keys can be
+                   decrypted instantly, which allows checking them often.
+          'key':   The same as the "disc" method if you do not have a file with player
+                   keys at compile time. If you do, disc key decryption will be faster.
+                   This is the default method also employed by libcss.
+        
+        Returns the now current value of DVDCSS_METHOD, expected value should be
+        the same as the mode string provided.
+        """
+        if mode is None:
+            os.unsetenv("DVDCSS_METHOD")
+            return None
+        os.environ["DVDCSS_METHOD"] = mode
+        return os.environ["DVDCSS_METHOD"]

setup.py

@@ -5,7 +5,7 @@
 
 setup(
     name="pydvdcss",
-    version="1.0.5",
+    version="1.0.6",
     author="PHOENiX",
     author_email="rlaphoenix@pm.me",
     description="Python wrapper for VideoLAN's libdvdcss.",