X-Git-Url: http://p2p-next.cs.pub.ro/gitweb/?a=blobdiff_plain;f=cis%2Fapi%2Fbase.py;h=9e4ea5eeeb798ef86719e9658c4f013fe78a1af6;hb=refs%2Fheads%2Fmaster;hp=96006f803ba0d83e7bbda2ccd3bc2425eb85ef91;hpb=42cb85273f6ef35a40c183f1184313bbc06afa05;p=living-lab-site.git diff --git a/cis/api/base.py b/cis/api/base.py index 96006f8..9e4ea5e 100644 --- a/cis/api/base.py +++ b/cis/api/base.py @@ -4,8 +4,12 @@ Base classes for the external programs API. """ -import cis_exceptions +import os import re +import random + +import cis_exceptions +import cis_util class BaseTranscoder: """ @@ -53,41 +57,38 @@ class BaseTranscoder: self.prog_bin = prog_bin if name is None: - if input_file.find('/') is not -1: - name = input_file[(input_file.rindex('/')+1):] - else: - name = input_file - if name.find('.') is not -1: - name = name[:name.rindex('.')] + name = cis_util.get_name(input_file) self.name = name - def transcode(self, container, a_codec=None, v_codec=None, + def transcode(self, container, extension=None, a_codec=None, v_codec=None, a_bitrate=None, a_samplingrate=None, a_channels=None, v_bitrate=None, v_framerate=None, v_resolution=None, v_dar=None): """ Transcodes the input file to an audio-video file. - container: possible values are listed in containers member as keys - a_codec: possible values are listed in a_codecs member as keys - v_codec: possible values are listed in v_codecs member as keys - a_bitrate: (numeric) audio bit rate - a_samplingrate: (numeric) audio sampling rate in Hz - a_channels: (numeric) number of audio channels - v_bitrate: (numeric) video bit rate - v_framerate: (numeric) number of frames per second for a video - v_resolution: (string) video image size as x - v_dar: video display aspect ratio as x or float + @param container: possible values are listed in containers member + as keys + @param a_codec possible values are listed in a_codecs member as keys + @param v_codec possible values are listed in v_codecs member as keys + @param a_bitrate (numeric) audio bit rate + @param a_samplingrate (numeric) audio sampling rate in Hz + @param a_channels (numeric) number of audio channels + @param v_bitrate (numeric) video bit rate + @param v_framerate (numeric) number of frames per second for a video + @param v_resolution (string) video image size as x + @param v_dar video display aspect ratio as x or float + @return output file name """ # Check parameters. if a_codec is None and v_codec is None: raise ValueError('No audio or video codec specified.') - if a_codec is not None and type(a_codec) is not str: + if a_codec is not None and type(a_codec) not in [str, unicode]: raise TypeError('Audio codec must be string.') - if v_codec is not None and type(v_codec) is not str: + if v_codec is not None and type(v_codec) not in [str, unicode]: raise TypeError('Video codec must be string.') if a_samplingrate is not None and type(a_samplingrate) is not int: @@ -107,26 +108,35 @@ class BaseTranscoder: and re.match('[\d]+:[\d]+', v_dar) is None): raise ValueError('Video display aspect ratio must be a float or a string like :.') - self.output_file = self.dest_path + self.name + self.output_file = os.path.join(self.dest_path, self.name) + if os.path.exists(self.output_file): + raise cis_exceptions.FileAlreadyExistsException( \ + 'file "%s" already exists' % self.output_file) + if v_resolution is not None: self.output_file += '_' self.output_file += v_resolution[(v_resolution.rindex('x')+1):] self.output_file += 'p' - ext = self.tr_extension(container, (v_codec is not None)) + if extension == None: + ext = self.tr_extension(container, (v_codec is not None)) + else: + ext = extension if ext is not None: self.output_file += '.' + ext - self._transcode(self.tr_container(container), + return self._transcode(self.tr_container(container), ext, self.tr_a_codec(a_codec), self.tr_v_codec(v_codec), a_bitrate, a_samplingrate, a_channels, v_bitrate, v_framerate, v_resolution, v_dar) - def _transcode(self, container, a_codec=None, v_codec=None, + def _transcode(self, container, extension=None, a_codec=None, v_codec=None, a_bitrate=None, a_samplingrate=None, a_channels=None, v_bitrate=None, v_framerate=None, v_resolution=None, v_dar=None): """ Called by transcode; must be overridden by a child class which effectively transcodes the input file. + + @return output file name """ pass @@ -134,7 +144,8 @@ class BaseTranscoder: """ Translates container API name into external program identifier.""" if not self.containers.has_key(name) or self.containers[name] is None: - raise cis_exceptions.NotImplementedException("Container " + name) + raise cis_exceptions.NotImplementedException("Container " + name \ + + "not implemented") return self.containers[name] @@ -155,7 +166,8 @@ class BaseTranscoder: """ Translates audio codec API name into external program identifier.""" if not self.a_codecs.has_key(name) or self.a_codecs[name] is None: - raise cis_exceptions.NotImplementedException("Audio Codec " + name) + raise cis_exceptions.NotImplementedException("Audio Codec " + name \ + + "not implemented") return self.a_codecs[name] @@ -163,6 +175,143 @@ class BaseTranscoder: """ Translates video codec API name into external program identifier.""" if not self.v_codecs.has_key(name) or self.v_codecs[name] is None: - raise cis_exceptions.NotImplementedException("Video Codec " + name) + raise cis_exceptions.NotImplementedException("Video Codec " + name \ + + "not implemented") return self.v_codecs[name] + + +class BaseThumbExtractor: + """ + Abstraction of the API class for the thumbnail extraction program. + + Thumbnail extracted are in JPEG format. + """ + + prog_bin = None + input_file = None + dest_path = '' + name = None + + def __init__(self, input_file, name=None, prog_bin=None): + self.input_file = input_file + if prog_bin is not None: + self.prog_bin = prog_bin + + if name is None: + name = cis_util.get_name(input_file) + + self.name = name + + def extract_thumb(self, seek_pos, resolution="120x90", index=0): + """ + Extracts a thumbnail from the video from a specified position + expressed in seconds (int/float). + + index: an index appended to the image name in order to avoid + overwriting. + """ + pass + + def extract_random_thumb(self, resolution="120x90", index=0): + """ + Extracts a thumbnail from the video from a random position. + """ + duration = self.get_video_duration() + seek_pos = random.random() * duration + self.extract_thumb(seek_pos, resolution, index) + + def extract_summary_thumbs(self, count, resolution="120x90"): + """ + Extracts a series of thumbnails from a video by taking several + snapshots. + + The snapshots are taken from equally spaced positions such that + `count` thumbs are extracted. + """ + duration = self.get_video_duration() + interval = duration / (count + 1) + + n_thumbs_extracted = 0 + seek_pos = interval + for index in range (0, count): + thumb_extracted = True + try: + self.extract_thumb(seek_pos, resolution, n_thumbs_extracted) + except cis_exceptions.ThumbExtractionException as e: + thumb_extracted = False + + if thumb_extracted: + n_thumbs_extracted += 1 + + seek_pos += interval + + return n_thumbs_extracted + + def get_output_file_name(self, index): + """ Returns the name required as output file name based on index. """ + output_file_name = os.path.join(self.dest_path, self.name) \ + + '_t' + ("%02d" % index) + '.jpg' + + #if os.path.exists(output_file_name): + #raise cis_exceptions.FileAlreadyExistsException( \ + #'file "%s" already exists' % output_file_name) + + return output_file_name + + def get_video_duration(self): + pass + + +class BaseFileTransferer: + """ + Ensures file transfer from the Web Server to the CIS (here). + + Several implementations can be done by extending this class for + file transfer protocol such as FTP, SCP, RSYNC, HTTP etc. + """ + + local_path = '' + remote_path = '' + + def __init__(self, local_path='', remote_path=''): + """ Initialize by setting local and remote paths for file transfer. """ + self.local_path = local_path + self.remote_path = remote_path + + def __del__(self): + self.close() + + def get(self, files): + """ + Transfers files locally from the Web Server. + + files: a list of file name strings + """ + pass + + def put(self, files): + """ + Transfers files from the Web Server locally. + + files: a list of file name strings + """ + pass + + def close(self): + """ + This method should be called when the instance is no longer required. + + Class's destructor calls this method. + """ + pass + + +class BaseAVInfo: + @staticmethod + def get_video_duration(input_file, formated=False): + """ + Returns the number of seconds of a video (int/float) if formated is + False and a string for duration formated as [HH:]:mm:ss otherwise. + """ + pass