1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313
|
## Copyright (c) MediaArea.net SARL. All Rights Reserved.
#
# Use of this source code is governed by a BSD-style license that can
# be found in the License.html file in the root of the source tree.
##
"""MediaConchLib Python wrapper module.
"""
import os as _os
import platform as _platform
from ctypes import CDLL as _CDLL
from ctypes import c_void_p as _c_void_p
from ctypes import c_char_p as _c_char_p
from ctypes import c_size_t as _c_size_t
from ctypes import c_bool as _c_bool
from ctypes import c_long as _c_long
from ctypes import c_int as _c_int
_module = _os.path.abspath(_os.path.dirname(__file__))
_machine = _platform.machine().lower()
_system = _platform.system().lower()
if _machine in ["i386", "i686"]:
_machine = "x86_32"
elif _machine in ["amd64"]:
_machine = "x86_64"
if _system == "darwin":
_library = "libmediaconch.0.dylib"
else:
_library = "libmediaconch.so.0"
try:
_MediaConchLib_Handler = _CDLL("{}/{}/{}/{}".format(_module, _system, _machine, _library))
except:
_MediaConchLib_Handler = _CDLL(_library)
class Format:
"""Possibles MediaConch output formats.
Attributes:
text: Text report.
xml: XML report.
maxml: MediaArea XML report (default).
html: HTML report.
simple: Global outcome.
csv: CSV report.
json: JSON report.
"""
text, xml, maxml, _, html, _, simple, csv, json, max = list(range(10))
class Report:
"""Possibles reports types in MediaConch output.
Attributes:
mediaconch: MediaConch implementation/policy report (Default).
mediainfo: MediaInfo report.
mediatrace: Parsing traces.
micromediatrace: Parsing traces (in compact format).
"""
mediaconch, mediainfo, mediatrace, _, _, micromediatrace, _, max = list(range(0, 8))
class MediaConchException(BaseException):
"""Raised when MediaConchLib sets get_last_error() to non-empty-string.
"""
class MediaConch:
"""Wrapper to call MediaConchLib native library C API through ctypes interface.
"""
_MediaConch_new = _MediaConchLib_Handler.MediaConch_new
_MediaConch_new.argtypes = []
_MediaConch_new.restype = _c_void_p
_MediaConch_delete = _MediaConchLib_Handler.MediaConch_delete
_MediaConch_delete.argtypes = [_c_void_p]
_MediaConch_delete.restype = None
_MediaConch_get_last_error = _MediaConchLib_Handler.MediaConch_get_last_error
_MediaConch_get_last_error.argtypes = [_c_void_p]
_MediaConch_get_last_error.restype = _c_char_p
_MediaConch_add_file = _MediaConchLib_Handler.MediaConch_add_file
_MediaConch_add_file.argtypes = [_c_void_p, _c_char_p]
_MediaConch_add_file.restype = _c_long
_MediaConch_add_report = _MediaConchLib_Handler.MediaConch_add_report
_MediaConch_add_report.argtypes = [_c_void_p, _c_size_t]
_MediaConch_add_report.restype = None
_MediaConch_add_policy = _MediaConchLib_Handler.MediaConch_add_policy
_MediaConch_add_policy.argtypes = [_c_void_p, _c_char_p]
_MediaConch_add_policy.restype = None
_MediaConch_set_format = _MediaConchLib_Handler.MediaConch_set_format
_MediaConch_set_format.argtypes = [_c_void_p, _c_size_t]
_MediaConch_set_format.restype = None
_MediaConch_set_display = _MediaConchLib_Handler.MediaConch_set_display
_MediaConch_set_display.argtypes = [_c_void_p, _c_char_p]
_MediaConch_set_display.restype = None
_MediaConch_set_mil_option = _MediaConchLib_Handler.MediaConch_set_mil_option
_MediaConch_set_mil_option.argtypes = [_c_void_p, _c_char_p, _c_char_p]
_MediaConch_set_mil_option.restype = None
_MediaConch_set_force_analyze = _MediaConchLib_Handler.MediaConch_set_force_analyze
_MediaConch_set_force_analyze.argtypes = [_c_void_p, _c_bool]
_MediaConch_set_force_analyze.restype = None
_MediaConch_set_policy_verbosity = _MediaConchLib_Handler.MediaConch_set_policy_verbosity
_MediaConch_set_policy_verbosity.argtypes = [_c_void_p, _c_int]
_MediaConch_set_policy_verbosity.restype = None
_MediaConch_set_implementation_verbosity = _MediaConchLib_Handler.MediaConch_set_implementation_verbosity
_MediaConch_set_implementation_verbosity.argtypes = [_c_void_p, _c_int]
_MediaConch_set_implementation_verbosity.restype = None
_MediaConch_get_report = _MediaConchLib_Handler.MediaConch_get_report
_MediaConch_get_report.argtypes = [_c_void_p, _c_long]
_MediaConch_get_report.restype = _c_char_p
_handle = _c_void_p(0)
def __init__(self, throws=True):
"""Create MediaConch object.
Args:
throws (bool): Raises exception if MediaConchLib report an error after an API call.
"""
self._handle = self._MediaConch_new()
self._throws = throws
if self._throws:
last_error = self.get_last_error()
if last_error:
raise MediaConchException(last_error)
def __del__(self):
self._MediaConch_delete(self._handle)
# API
def get_last_error(self):
"""Get MediaConchLib error message for the last API call.
If self._throws is set to True, an exception is raised if
this fuction returns an non-empty string after an API call.
Otherwise you have to check the returned value manually.
Returns:
str: Error string (empty if none).
"""
return self._MediaConch_get_last_error(self._handle).decode("utf_8", "ignore")
def add_file(self, filename):
"""Add file to MediaConch database.
Args:
filename (str): File to add.
Returns:
int: File ID (-1 on error).
Raises:
MediaConchException: If self._throws is set to True and MediaConchLib report an error.
"""
value = self._MediaConch_add_file(self._handle, filename.encode("utf-8"))
if self._throws:
last_error = self.get_last_error()
if last_error:
raise MediaConchException(last_error)
return value
def add_report(self, report):
"""Add report type in the output report.
Args:
report (Report): Report type.
Raises:
MediaConchException: If self._throws is set to True and MediaConchLib report an error.
"""
self._MediaConch_add_report(self._handle, report)
if self._throws:
last_error = self.get_last_error()
if last_error:
raise MediaConchException(last_error)
def add_policy(self, filename):
"""Add a policy to validate files against.
Args:
filename (str): Policy file.
Raises:
MediaConchException: If self._throws is set to True and MediaConchLib report an error.
"""
self._MediaConch_add_policy(self._handle, filename.encode("utf-8"))
if self._throws:
last_error = self.get_last_error()
if last_error:
raise MediaConchException(last_error)
def set_format(self, format):
"""Set report format (internal display file).
Args:
format (Format): Report format.
Raises:
MediaConchException: If self._throws is set to True and MediaConchLib report an error.
"""
self._MediaConch_set_format(self._handle, format)
if self._throws:
last_error = self.get_last_error()
if last_error:
raise MediaConchException(last_error)
def set_display(self, filename):
"""Set custom display.
Args:
filename (str): Display file.
Raises:
MediaConchException: If self._throws is set to True and MediaConchLib report an error.
"""
self._MediaConch_set_display(self._handle, filename.encode("utf-8"))
if self._throws:
last_error = self.get_last_error()
if last_error:
raise MediaConchException(last_error)
def set_mil_option(self, name, value):
"""Pass option to the MediaInfo library.
Args:
name (str): MediaInfo option name.
value (str): Option value.
Raises:
MediaConchException: If self._throws is set to True and MediaConchLib report an error.
"""
self._MediaConch_set_mil_option(self._handle, name.encode("utf-8"), value.encode("utf-8"))
if self._throws:
last_error = self.get_last_error()
if last_error:
raise MediaConchException(last_error)
def set_force_analyze(self, force):
"""Force add_file() to reparse the file if registered in database.
Args:
force (bool): Mode.
Raises:
MediaConchException: If self._throws is set to True and MediaConchLib report an error.
"""
self._MediaConch_set_force_analyze(self._handle, force)
if self._throws:
last_error = self.get_last_error()
if last_error:
raise MediaConchException(last_error)
def set_policy_verbosity(self, verbosity):
"""Set verbosity for the policy report.
Parameters:
verbosity (int): Requested verbosity.
Raises:
MediaConchException: If self._throws is set to True and MediaConchLib report an error.
"""
self._MediaConch_set_policy_verbosity(self._handle, verbosity)
if self._throws:
last_error = self.get_last_error()
if last_error:
raise MediaConchException(last_error)
def set_implementation_verbosity(self, verbosity):
"""Set verbosity for the implementation report.
Args:
verbosity (int): Requested verbosity.
Raises:
MediaConchException: If self._throws is set to True and MediaConchLib report an error.
"""
self._MediaConch_set_implementation_verbosity(self._handle, verbosity)
if self._throws:
last_error = self.get_last_error()
if last_error:
raise MediaConchException(last_error)
def get_report(self, file_id):
"""Get report for the given file ID.
Args:
file_id (int): File ID returned by add_file() function.
Returns:
str: Requested report (empty if error).
Raises:
MediaConchException: If self._throws is set to True and MediaConchLib report an error.
"""
value = self._MediaConch_get_report(self._handle, file_id).decode("utf_8", "ignore")
if self._throws:
last_error = self.get_last_error()
if last_error:
raise MediaConchException(last_error)
return value
|