pyvisi/py_src/movie.py

"""
@author: John NGUI
"""

from esys.pyvisi.constant import ImageFormat
from os import system

class Movie:
    """
    Class that creates a file called 'make_movie' by default (if a parameter 
    file name is not speficied) which contains a list of parameters required 
    by the 'ppmtompeg' command to generate a movie from a series of images.
    """
    
    def __init__(self, parameter_file = "make_movie"):  
        """
        Initialise the generation of the movie.

        @type parameter_file: String
        @param parameter_file: Name of the file containing the list of 
                parameters required by the 'ppmtompeg' command.
        """

        self.__parameter_file = parameter_file

    def makeMovie(self, input_directory, first_image, last_image, movie):
        """
        Coordinate the generation of the movie.

        @type input_directory: String
        @param input_directory: Directory in which the series of images can 
                be found
        @type first_image: String
        @param first_image: First image name (including the extension)
        @type last_image: String
        @param last_image: Last image name (including the extension)
        @type movie : String
        @param movie: Movie name (including the extension)
        """

        self.__input_directory = input_directory
        self.__first_image = first_image
        self.__last_image = last_image
        self.__movie = movie

        self.__splitInput()
        self.__retrieveFirstImageDetails()
        self.__retrieveLastImageDetails()
        self.__retrieveConversionCommand()
        self.__generateParameterFile()

        # If a parameter file name was not specified, then the default file 
        # will be deleted automatically once the movie has been generated. 
        # However, if a paramter file name was specified, the file will be 
        # maintained.
        system('ppmtompeg ' + self.__parameter_file)
        if(self.__parameter_file == "make_movie"):
            system('rm ' + self.__parameter_file)

    def __splitInput(self):
        """
        Split the image label (i.e. temp-0001.jpg) to separate the 
        image name (i.e. temp-0001) and image format (i.e. jpg).
        """

        # Image format (i.e. jpg)
        self.__image_format = self.__first_image.split('.')[1]
        # First image name.
        self.__first_image = self.__first_image.split('.')[0]
        # Last image name.
        self.__last_image = self.__last_image.split('.')[0]

    def __retrieveFirstImageDetails(self):
        """
        Retrieve the first image name details.
        """

        # For a image called 'temp-0001.jpg', self.__first_image_number 
        # will be '0001', while self.__image_prefix will be 'temp-'.
        self.__first_image_number = ""
        self.__image_prefix = ""

        for i in range(len(self.__first_image)):
            if(self.__first_image[i].isdigit()): # Retrieve first image number.
                self.__first_image_number = \
                        self.__first_image_number + self.__first_image[i]
            else: # Retrieve image prefix.
                self.__image_prefix = \
                        self.__image_prefix + self.__first_image[i]
            
    def __retrieveLastImageDetails(self):
        """
        Retrieve the last image name details.
        """

        self.__last_image_number = ""

        for i in range(len(self.__last_image)):
            if(self.__last_image[i].isdigit()): # Retrieve last image number.
                self.__last_image_number = \
                        self.__last_image_number + self.__last_image[i]

        # The last image number is deducted by one. This allows the user
        # to use the same image range when generating a movie as the 
        # ones used for the for-loop.
        #self.__last_image_number = unicode(int(self.__last_image_number) - 1)
        
    def __retrieveConversionCommand(self):
        """
        Retrieve the conversion command (depending on the image format)
        required by the 'ppmtompeg' command.
        """
        print "-----", self.__image_format
        if(self.__image_format.endswith(ImageFormat.JPG)):
            self.__command = 'jpeg'
        elif(self.__image_format.endswith(ImageFormat.BMP)):
            self.__command = ImageFormat.BMP
        elif(self.__image_format.endswith(ImageFormat.PNM)):
            self.__command = ImageFormat.PNM
        elif(self.__image_format.endswith(ImageFormat.PNG)):
            self.__command = ImageFormat.PNG
        elif(self.__image_format.endswith(ImageFormat.TIF)):
            self.__command = ImageFormat.TIF
        else:
            raise IOError("ERROR: Invalid image format.")


    def __generateParameterFile(self):
        """
        Write the list of parameters into the file. 
        """

        parameter_file = open(self.__parameter_file, 'w')

        parameter_file.write('PATTERN IBBPBBPBBPBBPBBP\n' +
            'OUTPUT ' + self.__movie + '\n' 
            'BASE_FILE_FORMAT PNM\n' + 
            'INPUT_CONVERT ' +  self.__command + 'topnm *\n' +
            'GOP_SIZE 16\n' +
            'SLICES_PER_FRAME 10\n' +
            'INPUT_DIR ' + self.__input_directory + '\n' +
            'INPUT\n' +
            self.__image_prefix + '*.' + self.__image_format + ' [' + \
                    self.__first_image_number + '-' + \
                    self.__last_image_number + ']\n'
            'END_INPUT\n' +
            'PIXEL HALF\n' +
            'RANGE 10\n' +
            'PSEARCH_ALG LOGARITHMIC\n' + 
            'BSEARCH_ALG CROSS2\n' +
            'IQSCALE 8\n' + 
            'PQSCALE 10\n' +
            'BQSCALE 25\n' + 
            'REFERENCE_FRAME DECODED\n' +
            'FORCE_ENCODE_LAST_FRAME\n' +
            'ASPECT_RATIO 1\n' +
            'FRAME_RATE 24')

        parameter_file.close()

1	"""
2	@author: John NGUI
3	"""
4
5	from esys.pyvisi.constant import ImageFormat
6	from os import system
7
8	class Movie:
9	"""
10	Class that creates a file called 'make_movie' by default (if a parameter
11	file name is not speficied) which contains a list of parameters required
12	by the 'ppmtompeg' command to generate a movie from a series of images.
13	"""
14
15	def __init__(self, parameter_file = "make_movie"):
16	"""
17	Initialise the generation of the movie.
18
19	@type parameter_file: String
20	@param parameter_file: Name of the file containing the list of
21	parameters required by the 'ppmtompeg' command.
22	"""
23
24	self.__parameter_file = parameter_file
25
26	def makeMovie(self, input_directory, first_image, last_image, movie):
27	"""
28	Coordinate the generation of the movie.
29
30	@type input_directory: String
31	@param input_directory: Directory in which the series of images can
32	be found
33	@type first_image: String
34	@param first_image: First image name (including the extension)
35	@type last_image: String
36	@param last_image: Last image name (including the extension)
37	@type movie : String
38	@param movie: Movie name (including the extension)
39	"""
40
41	self.__input_directory = input_directory
42	self.__first_image = first_image
43	self.__last_image = last_image
44	self.__movie = movie
45
46	self.__splitInput()
47	self.__retrieveFirstImageDetails()
48	self.__retrieveLastImageDetails()
49	self.__retrieveConversionCommand()
50	self.__generateParameterFile()
51
52	# If a parameter file name was not specified, then the default file
53	# will be deleted automatically once the movie has been generated.
54	# However, if a paramter file name was specified, the file will be
55	# maintained.
56	system('ppmtompeg ' + self.__parameter_file)
57	if(self.__parameter_file == "make_movie"):
58	system('rm ' + self.__parameter_file)
59
60	def __splitInput(self):
61	"""
62	Split the image label (i.e. temp-0001.jpg) to separate the
63	image name (i.e. temp-0001) and image format (i.e. jpg).
64	"""
65
66	# Image format (i.e. jpg)
67	self.__image_format = self.__first_image.split('.')[1]
68	# First image name.
69	self.__first_image = self.__first_image.split('.')[0]
70	# Last image name.
71	self.__last_image = self.__last_image.split('.')[0]
72
73	def __retrieveFirstImageDetails(self):
74	"""
75	Retrieve the first image name details.
76	"""
77
78	# For a image called 'temp-0001.jpg', self.__first_image_number
79	# will be '0001', while self.__image_prefix will be 'temp-'.
80	self.__first_image_number = ""
81	self.__image_prefix = ""
82
83	for i in range(len(self.__first_image)):
84	if(self.__first_image[i].isdigit()): # Retrieve first image number.
85	self.__first_image_number = \
86	self.__first_image_number + self.__first_image[i]
87	else: # Retrieve image prefix.
88	self.__image_prefix = \
89	self.__image_prefix + self.__first_image[i]
90
91	def __retrieveLastImageDetails(self):
92	"""
93	Retrieve the last image name details.
94	"""
95
96	self.__last_image_number = ""
97
98	for i in range(len(self.__last_image)):
99	if(self.__last_image[i].isdigit()): # Retrieve last image number.
100	self.__last_image_number = \
101	self.__last_image_number + self.__last_image[i]
102
103	# The last image number is deducted by one. This allows the user
104	# to use the same image range when generating a movie as the
105	# ones used for the for-loop.
106	#self.__last_image_number = unicode(int(self.__last_image_number) - 1)
107
108	def __retrieveConversionCommand(self):
109	"""
110	Retrieve the conversion command (depending on the image format)
111	required by the 'ppmtompeg' command.
112	"""
113	print "-----", self.__image_format
114	if(self.__image_format.endswith(ImageFormat.JPG)):
115	self.__command = 'jpeg'
116	elif(self.__image_format.endswith(ImageFormat.BMP)):
117	self.__command = ImageFormat.BMP
118	elif(self.__image_format.endswith(ImageFormat.PNM)):
119	self.__command = ImageFormat.PNM
120	elif(self.__image_format.endswith(ImageFormat.PNG)):
121	self.__command = ImageFormat.PNG
122	elif(self.__image_format.endswith(ImageFormat.TIF)):
123	self.__command = ImageFormat.TIF
124	else:
125	raise IOError("ERROR: Invalid image format.")
126
127
128	def __generateParameterFile(self):
129	"""
130	Write the list of parameters into the file.
131	"""
132
133	parameter_file = open(self.__parameter_file, 'w')
134
135	parameter_file.write('PATTERN IBBPBBPBBPBBPBBP\n' +
136	'OUTPUT ' + self.__movie + '\n'
137	'BASE_FILE_FORMAT PNM\n' +
138	'INPUT_CONVERT ' + self.__command + 'topnm *\n' +
139	'GOP_SIZE 16\n' +
140	'SLICES_PER_FRAME 10\n' +
141	'INPUT_DIR ' + self.__input_directory + '\n' +
142	'INPUT\n' +
143	self.__image_prefix + '*.' + self.__image_format + ' [' + \
144	self.__first_image_number + '-' + \
145	self.__last_image_number + ']\n'
146	'END_INPUT\n' +
147	'PIXEL HALF\n' +
148	'RANGE 10\n' +
149	'PSEARCH_ALG LOGARITHMIC\n' +
150	'BSEARCH_ALG CROSS2\n' +
151	'IQSCALE 8\n' +
152	'PQSCALE 10\n' +
153	'BQSCALE 25\n' +
154	'REFERENCE_FRAME DECODED\n' +
155	'FORCE_ENCODE_LAST_FRAME\n' +
156	'ASPECT_RATIO 1\n' +
157	'FRAME_RATE 24')
158
159	parameter_file.close()
160