Merge pull request #74 from diegodorado/json-output-format

Add JSON output format as a simple array of frames

Author: joelibaceta

bin/video-to-ascii

@@ -11,8 +11,10 @@ PARSER.add_argument('-f', '--file', type=str, dest='file', help='input video fil
 PARSER.add_argument('--strategy', default='ascii-color', type=str, dest='strategy', 
     choices=["ascii-color", "just-ascii", "filled-ascii"], help='choose an strategy to render the output', action='store')
 PARSER.add_argument('-o', '--output', type=str, dest='output', help='output file to export', action='store')
+PARSER.add_argument('--output-format', default='sh', type=str, dest='output_format', 
+    choices=["sh", "json"], help='choose an output format to render the output', action='store')
 PARSER.add_argument('--with-audio', dest='with_audio', help='play audio', action='store_true')
 
 ARGS = PARSER.parse_args()
 
-player.play(ARGS.file, strategy=ARGS.strategy, output=ARGS.output, play_audio=ARGS.with_audio)
+player.play(ARGS.file, strategy=ARGS.strategy, output=ARGS.output, output_format=ARGS.output_format, play_audio=ARGS.with_audio)

video_to_ascii/player.py

@@ -3,7 +3,7 @@
 import tempfile
 from . import video_engine as ve
 
-def play(filename, strategy=None, output=None, play_audio=False):
+def play(filename, strategy=None, output=None, output_format=None, play_audio=False):
     """
     Play or export a video from a file by default using ascii chars in terminal
     """
@@ -20,4 +20,4 @@ def play(filename, strategy=None, output=None, play_audio=False):
         engine.with_audio = True
     if strategy is not None:
         engine.set_strategy(strategy)
-    engine.play(output)
+    engine.play(output, output_format)

video_to_ascii/render_strategy/ascii_strategy.py

@@ -70,7 +70,7 @@ def apply_pixel_to_ascii_strategy(self, pixel):
     def apply_end_line_modifier(self, msg):
         return msg
 
-    def render(self, cap, output=None, with_audio=False):
+    def render(self, cap, output=None, output_format=None, with_audio=False):
         """
         Iterate each video frame to print a set of ascii chars
 
@@ -114,9 +114,11 @@ def render(self, cap, output=None, with_audio=False):
 
         if output is not None:
             file = open(output, 'w+')
-            file.write("#!/bin/bash \n")
-            file.write("echo -en '\033[2J' \n")
-            file.write("echo -en '\u001b[0;0H' \n")
+
+            if output_format == 'sh':
+                file.write("#!/bin/bash \n")
+                file.write("echo -en '\033[2J' \n")
+                file.write("echo -en '\u001b[0;0H' \n")
 
         time_delta = 1./fps
         counter=0
@@ -158,11 +160,27 @@ def render(self, cap, output=None, with_audio=False):
                     print("\u001b[2A")
                 else:
                     print("\x1b[2A")
-                resized_frame = self.resize_frame(frame)
-                msg = self.convert_frame_pixels_to_ascii(resized_frame, new_line_chars=True)
-                file.write("sleep 0.033 \n")
-                file.write("echo -en '" + msg + "'" + "\n" ) 
-                file.write("echo -en '\u001b[0;0H' \n")
+
+                if output_format == 'sh':
+                    resized_frame = self.resize_frame(frame)
+                    msg = self.convert_frame_pixels_to_ascii(resized_frame, new_line_chars=True)
+                    file.write("sleep 0.033 \n")
+                    file.write("echo -en '" + msg + "'" + "\n" ) 
+                    file.write("echo -en '\u001b[0;0H' \n")
+                elif output_format == 'json':
+                    # scale each frame according to terminal dimensions
+                    resized_frame = self.resize_frame(frame, (cols, rows))
+                    msg = self.convert_frame_pixels_to_ascii(resized_frame, (cols, rows), new_line_chars=True)
+                    lines = msg.split("\n")
+                    # remove last line breaks (\n\r) which generate two extra unwanted array elements
+                    lines = lines[0:-2]
+                    # opening brackets
+                    file.write("[[\n" if counter == 0  else ",[\n")
+                    for i in range(len(lines)):
+                        file.write(f"\"{lines[i]}\"")
+                        # closing brackets
+                        file.write("]\n" if i == (len(lines) - 1)  else ",\n")
+
             counter += 1
         if with_audio:
             stream.close()
@@ -172,6 +190,10 @@ def render(self, cap, output=None, with_audio=False):
         else:
             os.system('cls') or None
 
+        # close the frame array
+        if output is not None and output_format == 'json':
+            file.write(f"]\n")
+
     def build_progress(self, progress, total):
         """Build a progress bar in the terminal"""
         progress_percent =  int(progress / total * 100) 

video_to_ascii/video_engine.py

@@ -28,11 +28,12 @@ def load_video_from_file(self, filename):
         cap = cv2.VideoCapture(filename)
         self.read_buffer = cap
 
-    def play(self, file=None):
+    def play(self, output=None, output_format=None):
         """
         Play the video captured using an specific render strategy
         """
 
         self.render_strategy.render(self.read_buffer, 
-            output=file, 
+            output=output, 
+            output_format=output_format, 
             with_audio=self.with_audio)