tictacsync 0.98a0__py3-none-any.whl → 1.4.0b0__py3-none-any.whl

tictacsync/timeline.py

@@ -9,7 +9,7 @@ from rich import print
 from itertools import groupby
 # import opentimelineio as otio
 from datetime import timedelta
-import shutil, os, sys, stat
+import shutil, os, sys, stat, subprocess
 from subprocess import Popen, PIPE
 from pprint import pformat
 
@@ -27,6 +27,7 @@ DB_OSX_NORM = -6 #dB
 OUT_DIR_DEFAULT = 'SyncedMedia'
 MCCDIR = 'SyncedMulticamClips'
 
+
 # utility to lock ISO audio files
 def remove_write_permissions(path):
     """Remove write permissions from this path, while keeping all other permissions intact.
@@ -38,7 +39,6 @@ def remove_write_permissions(path):
     NO_GROUP_WRITING = ~stat.S_IWGRP
     NO_OTHER_WRITING = ~stat.S_IWOTH
     NO_WRITING = NO_USER_WRITING & NO_GROUP_WRITING & NO_OTHER_WRITING
-
     current_permissions = stat.S_IMODE(os.lstat(path).st_mode)
     os.chmod(path, current_permissions & NO_WRITING)
 
@@ -55,6 +55,10 @@ def _pathname(tempfile_or_path) -> str:
     else:
         raise Exception('%s should be Path or tempfile...'%tempfile_or_path)
 
+def ffprobe_duration(f):
+    pr = ffmpeg.probe(f)
+    return pr['format']['duration']
+
 # utility for printing groupby results
 def print_grby(grby):
     for key, keylist in grby:
@@ -202,7 +206,7 @@ def _sox_multi2stereo(multichan_tmpfl, stereo_trxs) -> tempfile.NamedTemporaryFi
     stereo_tempfile = tempfile.NamedTemporaryFile(suffix='.wav',
                     delete=DEL_TEMP)
     tfm = sox.Transformer()
-    tfm.channels(1)
+    tfm.channels(1) # why ? https://pysox.readthedocs.io/en/latest/api.html?highlight=channels#sox.transform.Transformer.channels
     status = tfm.build(_pathname(multichan_tmpfl),_pathname(stereo_tempfile))
     logger.debug('n chan ouput: %s'%
                 sox.file_info.channels(_pathname(stereo_tempfile)))
@@ -401,6 +405,7 @@ class AudioStitcherVideoMerger:
         Returns audio recordings that overlap self.videoclip.
         Simply keys of self.soxed_audio dict
         """
+        logger.debug(f'soxed_audio {pformat(self.soxed_audio)}')
         return list(self.soxed_audio.keys())
 
     def _get_audio_devices(self):
@@ -411,15 +416,16 @@ class AudioStitcherVideoMerger:
         return devices
 
     def _get_secondary_audio_devices(self):
-        devices = set([r.device for r in self.get_matched_audio_recs()])
-        logger.debug('get_matched_audio_recs: %s'%
-            pformat(self.get_matched_audio_recs()))
-        logger.debug('devices %s'%devices)
-        return devices
+        # when only audio devices are synced.
+        # identical to _get_audio_devices()...
+        # name changed for clarity
+        return self._get_audio_devices()
 
     def _get_all_recordings_for(self, device):
         # return recordings for a particular device, sorted by time
-        recs = [a for a in self.get_matched_audio_recs() if a.device == device]
+        recs = self.get_matched_audio_recs()
+        logger.debug(f'device: {device.name} matched audio recs: {recs}')
+        recs = [a for a in recs if a.device == device]
         recs.sort(key=lambda r: r.start_time)
         return recs
 
@@ -652,14 +658,16 @@ class AudioStitcherVideoMerger:
         self.soxed_audio[audio_rec] = output_fh
         return output_fh
 
-    def _write_ISOs(self, edited_audio_all_devices):
+    def _write_ISOs(self, edited_audio_all_devices,
+                snd_root=None, synced_root=None, raw_root=None, audio_only=False):
         """
+        [TODO: this multiline doc is obsolete]
         Writes isolated audio files that were synced to synced_clip_file,
         each track will have its dedicated monofile, named sequentially or with
-        the name find in TRACKSFN if any, see Scanner._get_tracks_from_file()
+        the name find in TRACKSFILE if any, see Scanner._get_tracks_from_file()
 
         edited_audio_all_devices:
-            a list of (name, mono_tempfile)
+            a list of (name, mono_tempfile, dev) -------------------------------------------> add argument for device for calling _get_all_recordings_for() for file for metada
 
         Returns nothing, output is written to filesystem as below.
         ISOs subfolders structure when user invokes the --isos flag:
@@ -671,7 +679,7 @@ class AudioStitcherVideoMerger:
                     canon24fps01.MOV ━━━━┓ name of clip is name of folder
                     canon24fps01_ISO/ <━━┛
                         chan_1.wav     
-                        chan_2.wav     
+                        chan_2.wav     [UPDATE FOR MAM mode]
                     canon24fps02.MOV 
                     canon24fps01_ISO/ 
                         chan_1.wav
@@ -707,20 +715,52 @@ class AudioStitcherVideoMerger:
                 sox.file_info.duration(_pathname(out_tf)))
             logger.debug('video duration  %.2f s'%
                 self.videoclip.get_duration())
+            logger.debug(f'video {self.videoclip}')
             return out_tf
-        synced_clip_file = self.videoclip.final_synced_file
-        synced_clip_dir = synced_clip_file.parent
+        def _meta_wav_dest(p1, p2, p3):
+            """
+            takes metadata from p1, sound from p2 and combine them to create p3.
+            arguments are pathlib.Path or string;
+            returns nothing.
+            """
+            f1, f2, f3 = [_pathname(p) for p in [p1, p2, p3]]
+            process_list = ['ffmpeg', '-y', '-loglevel', 'quiet', '-nostats', '-hide_banner',
+                    '-i', f1, '-i', f2, '-map', '1',
+                    '-map_metadata', '0', '-c', 'copy', f3]
+            proc = subprocess.run(process_list)
+        logger.debug(f'synced_clip_file raw')
+        if snd_root == None:
+            # alongside mode
+            synced_clip_file = self.videoclip.final_synced_file
+            logger.debug('alongside mode')
+            synced_clip_dir = synced_clip_file.parent
+        else:
+            # MAM mode
+            synced_clip_file = self.videoclip.AVpath
+            logger.debug('MAM mode')
+            rel = synced_clip_file.parent.relative_to(raw_root)
+            synced_clip_dir = Path(snd_root)/Path(raw_root).name/rel
+            logger.debug(f'synced_clip_dir: {synced_clip_dir}')
         # build ISOs subfolders structure, see comment string below
         video_stem_WO_suffix = synced_clip_file.stem
-        ISOdir = synced_clip_dir/(video_stem_WO_suffix + '_ISO')
+        # ISOdir = synced_clip_dir/(video_stem_WO_suffix + 'ISO')
+        ISOdir = synced_clip_dir/(video_stem_WO_suffix + '_SND')/'ISOfiles'
         os.makedirs(ISOdir, exist_ok=True)
         logger.debug('edited_audio_all_devices %s'%edited_audio_all_devices)
         logger.debug('ISOdir %s'%ISOdir)
-        for name, mono_tmpfl in edited_audio_all_devices:
-            destination = ISOdir/('%s.wav'%name)
+        for name, mono_tmpfl, device in edited_audio_all_devices:
+            logger.debug(f'name:{name} mono_tmpfl:{mono_tmpfl} device:{pformat(device)}')
+            # destination = ISOdir/(f'{video_stem_WO_suffix}_{name}.wav')
+            destination = ISOdir/(f'{name}_{video_stem_WO_suffix}.wav')
             mono_tmpfl_trimpad = _fit_length(mono_tmpfl)
-            shutil.copy(_pathname(mono_tmpfl_trimpad), destination)
-            remove_write_permissions(destination)
+            # if audio_only, self.ref_audio does not have itself as matching audio
+            if audio_only and device == self.ref_audio.device:
+                first_rec = self.ref_audio
+            else:
+                first_rec = self._get_all_recordings_for(device)[0]
+            logger.debug(f'will use {first_rec} for metadata source to copy over {destination}')
+            _meta_wav_dest(first_rec.AVpath, mono_tmpfl_trimpad, destination)
+            # remove_write_permissions(destination)
             logger.debug('destination:%s'%destination)
 
     def _get_device_mix(self, device, multichan_tmpfl) -> tempfile.NamedTemporaryFile:
@@ -794,8 +834,8 @@ class AudioStitcherVideoMerger:
         if device.ttc + 1 != device.tracks.ttc: # warn and quit
             print('Error: TicTacCode channel detected is [gold1]%i[/gold1]'%
                 (device.ttc), end=' ')
-            print('and [gold1]%s[/gold1] for the device [gold1]%s[/gold1] specifies channel [gold1]%i[/gold1],'%
-                (device_scanner.TRACKSFN,
+            print('and file [gold1]%s[/gold1]\nfor the device [gold1]%s[/gold1] specifies channel [gold1]%i[/gold1],'%
+                (device.folder/Path(yaltc.TRACKSFILE),
                 device.name, device.tracks.ttc-1))
             print('Please correct the discrepancy and rerun. Quitting.')
             sys.exit(1)
@@ -866,19 +906,7 @@ class AudioStitcherVideoMerger:
         stereo_files = mic_stereo_files + new_stereo_files
         return _sox_mix_files(stereo_files)
 
-    def build_audio_and_write_merged_media(self, top_dir, 
-                            dont_write_cam_folder, asked_ISOs, audio_REC_only):
-        # simply bifurcates depending if ref media is video (prob 99%)
-        # (then audio_REC_only == False)
-        # or if ref media is audio (no camera detected, 1% of cases)
-        # (with audio_REC_only == True)
-        if not audio_REC_only:
-            self._build_audio_and_write_video(top_dir,
-                                    dont_write_cam_folder, asked_ISOs)
-        else:
-            self._build_and_write_audio(top_dir, anchor_dir)
-
-    def _build_and_write_audio(self, top_dir, anchor_dir):
+    def _build_and_write_audio(self, top_dir, anchor_dir=None):
         """
         This is called when only audio recorders were found (no cam).
 
@@ -910,8 +938,7 @@ class AudioStitcherVideoMerger:
         self.synced_clip_dir = synced_clip_dir
         os.makedirs(synced_clip_dir, exist_ok=True)
         logger.debug('synced_clip_dir is: %s'%synced_clip_dir)
-        synced_clip_file = synced_clip_dir/\
-            Path(self.videoclip.new_rec_name).name
+        synced_clip_file = synced_clip_dir/self.videoclip.AVpath.name
         logger.debug('editing files for synced_clip_file%s'%synced_clip_file)
         self.ref_audio.final_synced_file = synced_clip_file # relative path
         # Collecting edited audio by device, in (Device, tempfile) pairs:
@@ -971,14 +998,15 @@ class AudioStitcherVideoMerger:
                 logger.debug('track_name %s'%track_name)
                 if track_name[0] == '0': # muted, skip
                     continue
-                names_audio_tempfiles.append((track_name, monotf))
-        logger.debug('names_audio_tempfiles %s'%names_audio_tempfiles)
-        self._write_ISOs(names_audio_tempfiles)
+                names_audio_tempfiles.append((track_name, monotf, dev))
+        logger.debug('names_audio_tempfiles %s'%pformat(names_audio_tempfiles))
+        self._write_ISOs(names_audio_tempfiles, audio_only=True)
         logger.debug('merged_audio_files_by_device %s'%
                             merged_audio_files_by_device)
 
     def _build_audio_and_write_video(self, top_dir, dont_write_cam_folder,
-                                            asked_ISOs):
+                                            asked_ISOs, synced_root = None,
+                                            snd_root = None, raw_root = None):
         """
         top_dir: Path, directory where media were looked for
 
@@ -1003,22 +1031,25 @@ class AudioStitcherVideoMerger:
             (top_dir, dont_write_cam_folder, asked_ISOs))
         logger.debug('device for rec %s: %s'%(self.videoclip,
             self.videoclip.device))
-        # eg, suppose the user called tictacsync with 'mondayPM' as top folder
-        # to scan for dailies (and 'somefolder' for output):
-        # if anchor_dir == None:
-        # then "alongside mode" i.e., in a folder neighboring the video clip
-        # WAS: synced_clip_dir = Path(top_dir)/OUT_DIR_DEFAULT # = mondayPM/SyncedMedia
-        logger.debug('"alongside mode" for clip: %s'%self.videoclip.AVpath)
-        synced_clip_dir = self.videoclip.AVpath.parent/OUT_DIR_DEFAULT
-        # else: # [TODO: replace original clip in a mirrored file structure]
-        #     logger.debug('mirrored mode for clip: %s'%self.videoclip.AVpath)
-        #     synced_clip_dir = Path(anchor_dir)/Path(top_dir).name # = somefolder/mondayPM
-        # if write_multicam_structure:
-        #     device_name = self.videoclip.device.name
-        #     synced_clip_dir = synced_clip_dir/device_name # = synced_clip_dir/ZOOM
+        if synced_root == None:
+            # alongside, within SyncedMedia dirs
+            synced_clip_dir = self.videoclip.AVpath.parent/OUT_DIR_DEFAULT
+            logger.debug('"alongside mode" for clip: %s'%self.videoclip.AVpath)
+            logger.debug(f'will save in {synced_clip_dir}')
+        else:
+            # MAM mode
+            logger.debug('MAM mode')
+            synced_clip_dir = Path(synced_root)/str(self.videoclip.AVpath.parent)[1:] # strip leading /
+            logger.debug(f'self.videoclip.AVpath.parent: {self.videoclip.AVpath.parent}')
+            logger.debug(f'raw_root {raw_root}')
+            # rel = self.videoclip.AVpath.parent.relative_to(raw_root).parent # removes ROLL01?
+            rel = self.videoclip.AVpath.parent.relative_to(raw_root)
+            logger.debug(f'relative path {rel}')
+            synced_clip_dir = Path(synced_root)/Path(raw_root).name/rel
+            logger.debug(f'will save in {synced_clip_dir}')
         self.synced_clip_dir = synced_clip_dir
         os.makedirs(synced_clip_dir, exist_ok=True)
-        logger.debug('synced_clip_dir is: %s'%synced_clip_dir)
+        # logger.debug('synced_clip_dir is: %s'%synced_clip_dir)
         synced_clip_file = synced_clip_dir/self.videoclip.AVpath.name
         logger.debug('editing files for synced_clip_file %s'%synced_clip_file)
         self.videoclip.final_synced_file = synced_clip_file # relative path
@@ -1104,6 +1135,7 @@ class AudioStitcherVideoMerger:
                 # generates track name for later if asked_ISOs
                 # idx is from 0 to nchan-1 for this device
                 if dev.tracks == None:
+                    logger.debug('dev.tracks == None')
                     # no tracks.txt was found so use ascending numbers for name
                     chan_name = 'chan%s'%str(idx+1).zfill(2)
                 else:
@@ -1131,9 +1163,10 @@ class AudioStitcherVideoMerger:
                     logger.debug('track_name %s'%track_name)
                     if track_name[0] == '0': # muted, skip
                         continue
-                    names_audio_tempfiles.append((track_name, monotf))
+                    names_audio_tempfiles.append((track_name, monotf, dev))
             logger.debug('names_audio_tempfiles %s'%pformat(names_audio_tempfiles))
-            self._write_ISOs(names_audio_tempfiles)
+            self._write_ISOs(names_audio_tempfiles,
+                snd_root=snd_root, synced_root=synced_root, raw_root=raw_root)
         logger.debug('merged_audio_files_by_device %s'%
             merged_audio_files_by_device)
         # This loop below for logging purpose only:
@@ -1177,9 +1210,12 @@ class AudioStitcherVideoMerger:
         """
         synced_clip_file = self.videoclip.final_synced_file
         video_path = self.videoclip.AVpath
+        logger.debug(f'original clip  {video_path}')
+        logger.debug(f'clip duration {ffprobe_duration(video_path)} s')
         timecode = self.videoclip.get_start_timecode_string()
         # self.videoclip.synced_audio = audio_path
         audio_path = self.videoclip.synced_audio
+        logger.debug(f'audio duration {sox.file_info.duration(_pathname(audio_path))}')
         vid_only_handle = self._keep_VIDEO_only(video_path)
         a_n = _pathname(audio_path)
         v_n = str(vid_only_handle.name)
@@ -1193,8 +1229,8 @@ class AudioStitcherVideoMerger:
         ffmpeg_args = (
             ffmpeg
             .input(v_n)
-            # .output(out_n, shortest=None, vcodec='copy',
-            .output(out_n, vcodec='copy',
+            .output(out_n, shortest=None, vcodec='copy',
+            # .output(out_n, vcodec='copy',
                 timecode=timecode)
             .global_args('-i', a_n, "-hide_banner")
             .overwrite_output()
@@ -1205,9 +1241,8 @@ class AudioStitcherVideoMerger:
             _, out = (
             ffmpeg
             .input(v_n)
-            .output(out_n, vcodec='copy',
-            # .output(out_n, shortest=None, vcodec='copy',
-                # metadata='reel_name=foo', not all container support gen MD
+            # .output(out_n, vcodec='copy',
+            .output(out_n, shortest=None, vcodec='copy',
                 timecode=timecode,
                 )
             .global_args('-i', a_n, "-hide_banner")
@@ -1215,8 +1250,8 @@ class AudioStitcherVideoMerger:
             .run(capture_stderr=True)
             )
             logger.debug('ffmpeg output')
-            for l in out.decode("utf-8").split('\n'):
-                logger.debug(l)
+            # for l in out.decode("utf-8").split('\n'):
+                # logger.debug(l)
         except ffmpeg.Error as e:
             print('ffmpeg.run error merging: \n\t %s + %s = %s\n'%(
                 audio_path,
@@ -1226,6 +1261,9 @@ class AudioStitcherVideoMerger:
             print(e)
             print(e.stderr.decode('UTF-8'))
             sys.exit(1)
+        logger.debug(f'merged clip  {out_n}')
+        logger.debug(f'clip duration {ffprobe_duration(out_n)} s')
+
 
 class Matcher:
     """
@@ -1267,21 +1305,6 @@ class Matcher:
         self.recordings = recordings_list
         self.mergers = []
 
-    # def _rename_all_recs(self):
-    #     """
-    #     Add _synced to filenames of synced video files. Change stored name only:
-    #     files have yet to be written to.
-    #     """
-    #     # match IO_structure:
-    #         # case 'foldercam':
-    #     for rec in self.recordings:
-    #         rec_extension = rec.AVpath.suffix
-    #         rel_path_new_name = '%s%s'%(rec.AVpath.stem, rec_extension)
-    #         rec.new_rec_name = Path(rel_path_new_name)
-    #         logger.debug('for %s new name: %s'%(
-    #             _pathname(rec.AVpath),
-    #             _pathname(rec.new_rec_name)))
-
     def scan_audio_for_each_videoclip(self):
         """
         For each video (and for the Main Sound) in self.recordings, this finds
@@ -1293,10 +1316,11 @@ class Matcher:
         V3 checked against    ...
         Main Sound checked against A1, A2, A3, A4
         """
-        video_recordings = [r for r in self.recordings if r.is_video()
-                                                            or r.is_reference]
+        video_recordings = [r for r in self.recordings
+                        if r.is_video() or r.is_audio_reference]
+        # if r.is_audio_reference then audio, and will pass as video                
         audio_recs = [r for r in self.recordings if r.is_audio()
-                                                and not r.is_reference]
+                                                and not r.is_audio_reference]
         if not audio_recs:
             print('\nNo audio recording found, syncing of videos only not implemented yet, exiting...\n')
             sys.exit(1)
@@ -1452,7 +1476,7 @@ class Matcher:
                 vid.write_file_timecode(tc)
         return
 
-    def move_multicam_to_dir(self):
+    def move_multicam_to_dir(self, raw_root=None, synced_root=None):
         # creates a dedicated multicam directory and move clusters there
         # e.g., for "top/day01/camA/roll02"
         #                       ^  at that level
@@ -1461,6 +1485,7 @@ class Matcher:
         #
         # check for consistency: are all clips at the same level from topdir?
         # Only for video, not audio (which doesnt fill up cards)
+        logger.debug(f'synced_root: {synced_root}')
         video_medias = [m for m in self.recordings if m.device.dev_type == 'CAM']
         video_paths = [m.AVpath.parts for m in video_medias]
         AV_path_lengths = [len(p) for p in video_paths]
@@ -1479,32 +1504,63 @@ class Matcher:
             sys.exit(0)
         # pick first
         CAM_level, avp = CAM_levels[0], video_medias[0].AVpath
-        logger.debug('CAM_levels: %s for ex \n%s'%(CAM_level, avp))
+        logger.debug('CAM_levels: %s for %s\n'%(CAM_level, avp))
         # MCCDIR = 'SyncedMulticamClips'
-        parts_up_a_level = avp.parts[:CAM_level]
-        multicam_dir = Path('').joinpath(*parts_up_a_level)/MCCDIR
+        parts_up_a_level = [prt for prt in avp.parts[:CAM_level] if prt != '/']
+        logger.debug(f'parts_up_a_level: {parts_up_a_level}')
+        if synced_root == None:
+            # alongside mode
+            logger.debug('alongside mode')
+            multicam_dir = Path('/').joinpath(*parts_up_a_level)/MCCDIR
+        else:
+            # MAM mode
+            logger.debug('MAM mode')
+            abs_path_up = Path('/').joinpath(*parts_up_a_level)/MCCDIR
+            logger.debug(f'abs_path_up: {abs_path_up}')
+            rel_up = abs_path_up.relative_to(raw_root)
+            logger.debug(f'rel_up: {rel_up}')
+            multicam_dir = Path(synced_root)/Path(raw_root).name/rel_up
+            # multicam_dir = Path(synced_root).joinpath(*parts_up_a_level)/MCCDIR
         logger.debug('multicam_dir: %s'%multicam_dir)
         Path.mkdir(multicam_dir, exist_ok=True)
         cam_clips = []
         [cam_clips.append(cl['vids']) for cl in self.multicam_clips_clusters]
         cam_clips = _flatten(cam_clips)
-        logger.debug('cam_clips: %s'%cam_clips)
+        logger.debug('cam_clips: %s'%pformat(cam_clips))
         cam_names = set([r.device.name for r in cam_clips])
         # create new dirs for each CAM
         [Path.mkdir(multicam_dir/cam_name, exist_ok=True)
                         for cam_name in cam_names]
         # move clips there
-        for r in cam_clips:
-            cam = r.device.name
-            clip_name = r.AVpath.name
-            dest = r.final_synced_file.replace(multicam_dir/cam/clip_name)
-            logger.debug('dest: %s'%dest)
-            origin_folder = r.final_synced_file.parent
-            folder_now_empty = len(list(origin_folder.glob('*.*'))) == 0
-            if folder_now_empty:
-                logger.debug('after moving %s, folder is now empty, removing it'%dest)
-                origin_folder.rmdir()
-        print('\nMoved %i multicam clips in %s'%(len(cam_clips), multicam_dir))
+        if synced_root == None:
+            # alongside mode
+            for r in cam_clips:
+                cam = r.device.name
+                clip_name = r.AVpath.name
+                dest = r.final_synced_file.replace(multicam_dir/cam/clip_name)
+                logger.debug('dest: %s'%dest)
+                origin_folder = r.final_synced_file.parent
+                folder_now_empty = len(list(origin_folder.glob('*'))) == 0
+                if folder_now_empty:
+                    logger.debug('after moving %s, folder is now empty, removing it'%dest)
+                    origin_folder.rmdir()
+            print('\nMoved %i multicam clips in %s'%(len(cam_clips), multicam_dir))
+        else:
+            # MAM mode
+            for r in cam_clips:
+                cam = r.device.name
+                clip_name = r.AVpath.name
+                logger.debug(f'r.final_synced_file: {r.final_synced_file}')
+                dest = r.final_synced_file.replace(multicam_dir/cam/clip_name)
+                # leave a symlink behind
+                os.symlink(multicam_dir/cam/clip_name, r.final_synced_file)
+                logger.debug('dest: %s'%dest)
+                origin_folder = r.final_synced_file.parent
+                # folder_now_empty = len(list(origin_folder.glob('*'))) == 0
+                # if folder_now_empty:
+                #     logger.debug('after moving %s, folder is now empty, removing it'%dest)
+                #     origin_folder.rmdir()
+            print('\nMoved %i multicam clips in %s'%(len(cam_clips), multicam_dir))