2021-12-08 Fred Gleason <fredg@paravelsystems.com>

* Added a 'TrimAudio()' method to the 'rivwebpyapi' API.

Signed-off-by: Fred Gleason <fredg@paravelsystems.com>

ChangeLog

@@ -22715,3 +22715,5 @@
 	* Added a 'LockLog()' method to the 'rivwebpyapi' API.
 2021-12-08 Fred Gleason <fredg@paravelsystems.com>
 	* Added a 'Rehash()' method to the 'rivwebpyapi' API.
+2021-12-08 Fred Gleason <fredg@paravelsystems.com>
+	* Added a 'TrimAudio()' method to the 'rivwebpyapi' API.

apis/rivwebpyapi/api/rivwebpyapi.py

@@ -1798,6 +1798,62 @@ class rivwebpyapi(object):
         if(r.status_code!=requests.codes.ok):
             self.__throwError(response=r)
 
+    def TrimAudio(self,cart_number,cut_number,trim_level):
+        """
+          Return time pointers to the first and last instance of a
+          particular level in a cut (dictionary).
+
+          Takes the following arguments:
+
+          cart_number - The number of the desired cart, in the range
+                        1 - 999999 (integer)
+
+          cut_number - The number of the desired cut, in the range
+                        1 - 999 (integer)
+          trim_level - Level in 1/100 dB, relative to Rivendell reference
+                       level [-16 dBFS] (integer).
+        """
+        if((cart_number<1)or(cart_number>999999)):
+            raise ValueError('invalid cart number')
+        if((cut_number<1)or(cut_number>999)):
+            raise ValueError('invalid cut number')
+        if(trim_level>1600):
+            raise ValueError('invalid trim level')
+
+        #
+        # Build the WebAPI arguments
+        #
+        postdata={
+            'COMMAND': '17',
+            'LOGIN_NAME': self.__connection_username,
+            'PASSWORD': self.__connection_password,
+            'CART_NUMBER': str(cart_number),
+            'CUT_NUMBER': str(cut_number),
+            'TRIM_LEVEL': str(trim_level)
+        }
+
+        #
+        # Fetch the XML
+        #
+        r=requests.post(self.__connection_url,data=postdata)
+        if(r.status_code!=requests.codes.ok):
+            self.__throwError(response=r)
+
+        #
+        # Generate the output dictionary
+        #
+        fields={
+            'cartNumber': 'integer',
+            'cutNumber': 'integer',
+            'trimLevel': 'integer',
+            'startTrimPoint': 'integer',
+            'endTrimPoint': 'integer'
+        }
+        handler=RivWebPyApi_ListHandler(base_tag='trimPoint',fields=fields)
+        xml.sax.parseString(r.text,handler)
+
+        return handler.output()[0]
+
     def UnassignSchedCode(self,cart_number,sched_code):
         """
           Unassign a schedule code from a cart.

apis/rivwebpyapi/tests/Makefile.am

@@ -47,6 +47,7 @@ EXTRA_DIST = add_cart.py\
              rehash.py\
              remove_cart.py\
              remove_cut.py\
+             trim_audio.py\
              unassign_sched_code.py
 
 CLEANFILES = *~\

apis/rivwebpyapi/tests/lock_log.py

@@ -38,7 +38,7 @@ guid=''
 #
 # Get login parameters
 #
-usage='import --url=<rd-url> --username=<rd-username> --log-name=<str> --operation=CREATE|UPDATE|CLEAR --guid=<str>'
+usage='lock_log --url=<rd-url> --username=<rd-username> --log-name=<str> --operation=CREATE|UPDATE|CLEAR --guid=<str>'
 for arg in sys.argv:
     f0=arg.split('=')
     if(len(f0)==2):

apis/rivwebpyapi/tests/trim_audio.py

@@ -0,0 +1,94 @@
+#!%PYTHON_BANGPATH%
+
+# trim_audio.py
+#
+# RivWebPyApi test script for Rivendell
+#
+#  Test the TrimAudio Web API call
+#
+#   (C) Copyright 2021 Fred Gleason <fredg@paravelsystems.com>
+#
+#   This program is free software; you can redistribute it and/or modify
+#   it under the terms of the GNU General Public License version 2 as
+#   published by the Free Software Foundation.
+#
+#   This program is distributed in the hope that it will be useful,
+#   but WITHOUT ANY WARRANTY; without even the implied warranty of
+#   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#   GNU General Public License for more details.
+#
+#   You should have received a copy of the GNU General Public
+#   License along with this program; if not, write to the Free Software
+#   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+#
+
+import getpass
+import rivwebpyapi
+import sys
+def eprint(*args,**kwargs):
+    print(*args,file=sys.stderr,**kwargs)
+
+url='';
+username=''
+password=''
+cart_number=0
+cut_number=0
+trim_level=1700
+
+#
+# Get parameters
+#
+usage='trim_audio.py --url=<rd-url> --username=<rd-username> --cart-number=<num> --cut-number=<num> --trim-level=<lvl> [--password=<passwd>]'
+for arg in sys.argv:
+    f0=arg.split('=')
+    if(len(f0)==2):
+        if(f0[0]=='--url'):
+            url=f0[1]
+        if(f0[0]=='--username'):
+            username=f0[1]
+        if(f0[0]=='--password'):
+            password=f0[1]
+        if(f0[0]=='--cart-number'):
+            cart_number=int(f0[1])
+        if(f0[0]=='--cut-number'):
+            cut_number=int(f0[1])
+        if(f0[0]=='--trim-level'):
+            trim_level=int(f0[1])
+
+if(not password):
+    password=getpass.getpass()
+if((not url)or(not username)):
+    print(usage)
+    sys.exit(1)
+if(cart_number==0):
+    eprint('you must supply "--cart-number"')
+    sys.exit(1)
+if(cut_number==0):
+    eprint('you must supply "--cut-number"')
+    sys.exit(1)
+if(trim_level==1700):
+    eprint('you must supply "--trim_level"')
+    sys.exit(1)
+
+#
+# Execute
+#
+webapi=rivwebpyapi.rivwebpyapi(url=url,username=username,password=password)
+try:
+    result=webapi.TrimAudio(cart_number=cart_number,cut_number=cut_number,
+                            trim_level=trim_level)
+except rivwebpyapi.RivWebPyError as err:
+    eprint('*** ERROR ***')
+    eprint('Response Code: '+str(err.responseCode))
+    eprint('ErrorString: '+str(err.errorString))
+    eprint('*************')
+    eprint('')
+    sys.exit(1)
+
+#
+# Display results
+#
+print('trimLevel: '+str(result['trimLevel']))
+print('startTrimPoint: '+str(result['startTrimPoint']))
+print('endTrimPoint: '+str(result['endTrimPoint']))
+print('')