R/copy_markers_from_D_to_C.R

In professorbeautiful/DUE: Dose Utility Explorer

#'   copy_markers_from_D_to_C()
#'   For copying Markers from Descript to Camtasia.
#'   Only copies into C main timeline.
#'   To keep any current C marker, move it onto a clip in a track 

#'  Step 0:
#'      Set variables:
projectLocation = '/Users/Roger/Google Drive/_HOME/DUE/DUE tour video/'
cmProjName = 'DUE tour video, in progress'
#'  Step 0:  If you've edited this file-- source it first! 
#'  Step 1:  In Descript, 
#'    A) Publish-> click Update, click Download.
#'        Save under any name desired.
#'        I pick, e.g. 2024-06-18 DUE tour video, in progress.mp4
#'        You need not wait until downloaded; see step 5.   
#'    B) Publish->Export->Transcript
#'      Export transcript as markdown.
#'      Toggle on Include markers
#'      Under Timecodes, toggle on Markers.
#'  Step 2: Make sure that the cmproj project is closed.
#'      (You don't have to quit Camtasia.)
#'  Step 3: run  copy_markers_from_D_to_C() to extract the marker info.
#'      This will save a BACKUP inside cmproj, AND copy newFile over the
#'      previous tscproj
#'      ALTERNATIVE:  
#'      R --vanilla --quiet -e "source('../R/copy_markers_from_D_to_C.R'); copy_markers_from_D_to_C()"
#'  Step 4:  reopen the project in C.  
#'    The markers from C will be there on the timeline; previous ones gone.
#'    Other markers on tracks will still be there.
#'  Step 5:  In C,  add media:   the previously downloaded  mp4 published by D.
#'           LOOK IN DOWNLOADS - D might have forgotten where you are.
#'        In C, add to playhead at T=0. Make another track,
#'         so you can separate audio and visual. 
#'           Before removing previous versions of the D export, 
#'           you might want to copy animations from previous versions.- 
#'        Usually, your additions in C supersede most or all of D visually.
#'  This should work whether there were previously markers or not.
#'  If there were, they will be overwritten, which is what we want.

#      

copy_markers_from_D_to_C =  function(  )  {
  cmProjPath = paste0(projectLocation, cmProjName, '.cmproj/')
  transcriptPath = paste0(projectLocation, cmProjName, '.md')
  if( ! file.exists(transcriptPath))
    stop('Transcript file not found')
  tscprojPath = paste0(cmProjPath,  'project.tscproj')
  if( ! file.exists(tscprojPath))
    stop('TSC file not found')
  hasAnyMarkers = function(){
    0 == invisible(system(intern = F, ignore.stdout=T,
                          paste0( "grep '\"toc\"' '", tscprojPath, "'")))
  } 
  if(hasAnyMarkers()) {
    cat("Reminder: Current timeline markers will be replaced. \n")
    
    # answer = readline("Current timeline markers will be replaced. OK? [y or newline = OK ; otherwise, abort]")
    # answer = print(ifelse( (answer !='') & (toupper(substr(answer, 1, 1)) != 'Y'),
    #                  'Abort',  'OK') )
    # if(answer=='Abort')
    #   stop ("OK, aborting\n"); 
  }
  
  # make a BACKUP just in case
  system(paste0('cp "', tscprojPath, '" "', tscprojPath, '".BACKUP.',
                gsub("[: ]", "-", date()) ))
  # Does the tscprojPath already have any markers?
  tscprojFile = readLines(tscprojPath)
  if(! identical(length(grep('"toc"', tscprojFile))>0,  
                 hasAnyMarkers()  ) )
    warning('failed toc test')
  transcript = readLines(transcriptPath)
  markers = grep('^##', transcript, v=T)
  head(markers)
  markerStrings = gsub('.*] ', '', markers)
  markerTimes = gsub('] .*', '', markers)
  markerTimes = gsub('##..', '', markerTimes)
  data.frame(markerTimes, markerStrings)
  
  markerTimesForCamtasia = sapply(
    strsplit(split = ':', markerTimes),
    function(tim) { #ignoring hours for now.
      paste0(tim[2], tim[3],'00')}
  )
  markerMinutes = as.numeric(sapply(
    strsplit(split = ':', markerTimes),
    function(tim) { tim[2]}
  ))
  markerSeconds = as.numeric(sapply(
    strsplit(split = ':', markerTimes),
    function(tim) { tim[3]}
  ))
  data.frame(markerMinutes,markerSeconds,markerTimes)
  DtoC_toc_time = function(minutes, seconds, frames=0)
    as.character((minutes*60*30 + seconds*30 + frames)* 2352)
  ### really 23520000  but need to avoid conversion to scientific notation
  
  markerTemplate = # 10 spaces, 12 spaces...
    '          {
            "endTime" : toc_time,
            "time" : toc_time,
            "value" : "markerString",
            "duration" : 0
          }'
  DtoC_toc_times = DtoC_toc_time(markerMinutes, markerSeconds)
  markerTemplateSubstituted = sapply(
    1:length(markerMinutes),
    function(ind)
      gsub(x=gsub('toc_time', 
                  paste0(DtoC_toc_time(markerMinutes[ind], 
                                       markerSeconds[ind]), '0000'), 
                  markerTemplate
      ),
      'markerString', markerStrings[ind])
  )
  markerTemplateSubstituted = paste(markerTemplateSubstituted, collapse=',\n')
  
  line_captionAttributes = grep('"captionAttributes"', tscprojFile)
  if(length(line_captionAttributes) !=1)
    warning("# if line_captionAttributes sis not ONE")
  # We ASSUME that the current markers are just before this
  postMarkerSection = tscprojFile[
    grep('"captionAttributes"', tscprojFile):length(tscprojFile)
  ]
  lines_toc = grep('"toc"', tscprojFile)
  #' Testing with quadrant\ info\ flow.cmproj/project.tscproj
  #' With no markers, no toc, and captionAttributes is there.
  #' With markers on main line and an object,
  #' the main line ones appear at the last toc section,
  #' without regard to temporal order.
  #' So we can safely (?) select the last toc.
  #' 
  
  if(hasAnyMarkers()) {  ##
    preMarkerSection = tscprojFile[
      1:max(grep('"toc"', tscprojFile) - 2)
    ]    # skip "parameters" line;  added below.
  } else {
    preMarkerSection = tscprojFile[
      1: (grep('"captionAttributes"', tscprojFile) - 1)
    ]
  }
  newFile <<- c(preMarkerSection, 
                '    "parameters" : {
      "toc" : {
        "type" : "string",
        "keyframes" : [',
                markerTemplateSubstituted,
                '       ]
      }
    },', postMarkerSection
  )
  writeLines(newFile, 'newFile.tscproj')
  writeLines(newFile, tscprojPath)
  # Now you can reopen the C project.
  system(paste0('open "' , cmProjPath, '"'))
  # Careful, when Camtasia is updated, update the default "open".
}

#'  
#'  OK this works. I pasted the tscproj into a new txt file here, 
#'  Then used writeLines to put markerTemplateSubstituted into pbcopy
#'  Then pasted into appropriate place (search "toc")
#'  Checked the boundaries.
#'  And the project opened with all the markers.
#'