Skip to content

Latest commit

 

History

History
233 lines (151 loc) · 9.55 KB

README.md

File metadata and controls

233 lines (151 loc) · 9.55 KB

SnapchatMemoriesCaptionAdder

Adds metadata (captions and timestamps) to your exported Snapchat memories.


Background

  • Snapchat allows you to save images/videos to their servers with their memories feature.
  • When you export your memories from Snapchat from their accounts website, you get all the memories, but with no metadata and the captions are stored separately!
  • This project adds metadata (captions and timestamps) to your exported Snapchat memories.

How it Works

  • The memories_history.json that Snapchat provides has all the metadata we need, but we need to combine it with the full memory export if we want captions.
  • This project serves as a bridge between these two methods! We have all the metadata and we have all the memory photos/videos and captions, we just need to combine them.
  • This project takes the base image and overlay image, combining them into a single file. Take a look at the visual example below.

Visual Example

Note

The caption is on the image, the file name and metadata has a timestamp! The file's creation date is also set to the correct date.

Final result


How it Works Visually

Overview


Overview

  • By utilizing this project, you can add metadata (captions and timestamps) to your exported Snapchat memories.
  • Once you are done adding the metadata using this project, you may then go to an alternate, fantastic, project like ToTheMax's Snapchat-All-Memories-Downloader
  • ToTheMax's Snapchat-All-Memories-Downloader uses a memories_history.json file to download all memories and add a timestamp, but this technique loses all the captions because they aren't included in memories_history.json file.

A preview of the memories_history.json file

{
  "Date": "2020-01-02 23:08:19 UTC",
  "Media Type": "Image",
  "Location": "Latitude, Longitude: 0.0, 0.0",
  "Download Link": "https://app.snapchat.com/dmd/memories?..."
}

Installation

Note

This project and documentation is not very friendly to non-developers :( If you have questions, I'm happy to try and help if you make a new Github issue. I'm very open to any PRs that want to work on making this more user-friendly (see the Contribution section below!)


This project requires Python to be installed on your computer. Once installed, you can clone this repo and run the following command to install the Python requirements for the project.

python -m pip install -r requirements.txt

This project also relies on two major libraries.

Note

Currently, this project does not work with ffmpeg 7.1+ due to this script using the depreciated scale2ref filter, please see #7 for more information. I plan on fixing this once ffmpeg 7 is available in Fedora Linux.

  • ffmpeg: "A complete, cross-platform solution to record, convert and stream audio and video."

    • This project uses ffmpeg 6 to overlay the captions onto videos.
    • If you're on Linux, download ffmpeg 6 from your package manager
    • If you're on MacOS, install ffmpeg@6 from brew
    • If you're on Windows, install it from winget with winget install -e --id Gyan.FFmpeg --version 6.0 (package here).

  • libvips: "A demand-driven, horizontally threaded image processing library. Compared to similar libraries, libvips runs quickly and uses little memory."


Usage


Gathering Data

First, we need to gather our data. Follow Snapchat's instructions to download your data. You'll need to do two separate exports:


First Export

  1. Follow Snapchat's instructions to download your data

  2. When downloading your data, Check Export your Memories, Chat Media and Shared Stories to download all your memories.

    • The status of the other checkmarks shouldn't matter, so feel free to export any additional data you'd like.

  3. Make sure the date range includes everything you want to export!

  4. If you choose to download multiple data packages, merge all the downloaded memories folders into a single memories folder. This is the only folder you need from the export for this script.


Note

This may take up a significant amount of space!


Second Export

  1. Create a second export, without Export your Memories, Chat Media and Shared Stories checked. Be sure to check Export JSON files and Memories and Other Media.

  2. Use the same date range as your first export. This export should take much less time for Snapchat to send to you :) In this data export, make sure you have a json folder with a memories_history.json file inside.

Note

This is the metadata for the memories, which is only generated when you don't export your memories.


Cloning the Repo

  1. Clone this repository to the preferred location on your drive

  2. Make a folder within the cloned repo called input

  3. Put the memories folder you created from the first export and the memories_history.json file from the second export into the input folder.

    • Alternatively, you can provide the location of the memories_history.json file with the --memories-history flag and the memories folder with the memories flag

For example:

python main.py --memories-history test/memories_history.json --memories-folder test/memories --output test_output.


Running the Script

With the folder prepared, you can now cd into the directory and run python main.py to run the script! It will create a new folder called output that will hold all memories with timestamps and captions.

Note

This will create a new copy of each photo/video, so make sure you have enough space! Alternatively, use the --output flag to provide a different location to dump the photos.

If you run into issues, run the script with the -v or --verbose flag, which will output information on what the script is doing. If that doesn't help you with the issue, open a GitHub issue with that output!

  • You can also use the -vv flag to get logs from ffmpeg/vips.

Other Flags

  • --image-only will only convert images and not videos
  • --video-only will only convert videos and not images
  • --only-one will only convert one video and one image. This is useful for debugging to see the log of only one conversion, or testing the script before running it on your entire library.

Warning

If your captions are important to you, double check the final result against the photos in the Snapchat app! I found that the memories export did not include overlays/captions from some of my photos in 2017-2018. So check the final photos to make sure the captions are there. If they aren't, you may need to download those impacted photos/videos directly from the Snapchat app. The majority of photos were successfully exported with all their captions.

Note

The timezone applied to the photos is set by your computer's local timezone! I'm open to any PRs to improve this.

  • For a quick hack you can set the default timezone in SnapchatMemoriesCaptionAdder/adder.py in the add_metadata signature.

Thanks

  • @n-katti for fixing issues on Windows and new Snapchat export format (issue #3)
  • @Enricon27 for fixing a problem with the earlier fix :) (issue #3)
  • @autumnesponda for adding location metadata
  • @3raxton for making the README.md file easier to understand

Contributing

This achieved what I needed it to do, so I don't anticipate adding many more features. I'd be happy to accept PRs for some features I didn't implement:


Making this much more user friendly.

  • This is currently not accessible to anyone who doesn't have knowledge of installing and using libraries.

  • Bundling libraries with the app

  • Creating a GUI


Cleaning the project up:

  • Introducing python-ffmpeg's async definitely made this functional but messy.

  • Snapchat uses UTC as the timezone for the timestamps.

    • This script takes a guess that your computer's local time zone is the timezone you want the timestamps in. Allowing the user to specify a timezone, or automatically determine the timezone from the photo's location data, would be an improvement.

  • I believe ffmpeg could also do photos, but it's less efficient than VIPS.

    Adding a fallback to ffmpeg would make installation easier for those who can't easily install VIPS.


License

MIT