Prep for v3.1.0-beta1

Readme.md

@@ -26,7 +26,7 @@
 * Randomized and ordered playback
 * Timing control
 * Caption scripting support
-* Audio track support
+* Audio track/playlist support and Audio Library to organize tracks
 * Library and Tagging to organize sources and generate slideshows
 * Easy to share!
 

docs/README.md

@@ -13,7 +13,7 @@
 * Randomized and ordered playback
 * Timing control
 * Caption scripting support
-* Audio track support
+* Audio track/playlist support and Audio Library to organize tracks
 * Library and Tagging to organize sources and generate slideshows
 * Easy to share!
 

docs/_coverpage.md

@@ -1,6 +1,6 @@
 ![logo](doc_images/flipflip_logo.png)
 
-# FlipFlip <small>3.0</small>
+# FlipFlip <small>3.1</small>
 
 > A glorified slideshow, with _lots_ of bells and whistles
 

docs/_sidebar.md

@@ -15,6 +15,12 @@
   - [Tagging](tagging.md)
   - [Import from Library](import_from_library.md)  
 
+- Audio Library
+
+  - [Overview](audio_library.md)
+  - [Tagging](audio_tagging.md)
+  - [Import from Library](audio_import_from_library.md)  
+
 - [Settings](config.md)
 - [Video Clipper](clips.md)
 - [Import/Export](import_export.md)

docs/audio_import_from_library.md

@@ -0,0 +1,10 @@
+# Importing Audio Library Tracks in Scene
+To import Audio Library tracks into a Scene, first make a new playlist from the Audio Card, and then click the `+` and 
+to add a track to that playlist. This will bring you to a view of your Library with checkboxes next to each track. You 
+can filter and sort this list to assist with locating sources. After you're done selecting the sources you want, click 
+the `Import` button ( <img style="vertical-align: -5px" src="doc_icons/import.svg" alt="Import" width="20" height="20"> ). 
+Your selected tracks will now appear in the playlist. Tracks are added in the order they were selected.
+
+?> **Tip**: Use the _SHIFT_ key to quickly select multiple sources
+
+![](doc_images/audio_library_import.png)

docs/audio_library.md

@@ -0,0 +1,70 @@
+# Audio Library
+The **Audio Library**, like the regular Source [Library](library.md), is a place for you to collect and manage all your 
+audio tracks. To access the Audio Library just click `Audio Library` icon in the Scene Picker (Home) sidebar 
+( <img style="vertical-align: -5px" src="doc_icons/audio_library.svg" alt="Audio Library" width="20" height="20"> )
+
+![](doc_images/audio_library.png)
+
+## Adding Tracks
+Add new tracks by going to the **Songs** tab and clicking the arrow in the bottom right. You can add tracks locally
+from your computer, or by entering a URL of an audio track.
+
+## Search/Filter
+Use the search bar to help find or filter the displayed items. Tags appear with a number indicating how many of 
+the displayed tracks have that tag.
+
+* Click on the search bar and select a tag, `<Marked>`, or `<Untagged>`.
+  * Start typing to find a particular tag.
+  * `<Marked>` shows only tracks that have been [marked](#marking-sources).
+  * `<Untagged>` shows only tracks which have no tags.
+* Type any term and press "Enter" or "Search for ___" to search. This is not case-sensitive.
+  * Default audio search includes **url**, **name**, **artist**, and  **album** metadata.
+* Type a phrase surrounded by `"` and `"` to search that exact phrase.
+  * By default -- without this option, FlipFlip splits separate words into separate search terms. 
+* Type a tag surrounded by `[` and `]` to search by tag.
+* Type `artist:` and then any term to search only the  **artist** field.
+* Type `album:` and then any term to search only the  **album** field.
+* Type `comment:` and then any term to search only the  **comment** field.
+* Type `-` and then any term or filter to _exclude_ those tracks.
+* Type `count>NUM`, `count<NUM`, or `count=NUM` to query based on the number of times a track has been played. 
+(Replace "NUM" with a number).
+
+## Marking Sources
+Users may wish to visually highlight certain items. To do this, search/filter the displayed tracks until they are 
+the ones you wish to highlight, and then press **Alt+M**. These tracks will be marked with a dot in the top-left, and 
+will remain that way after the search/filter is cleared. This may be useful for keeping track of a set of tracks you 
+are working on (for instance new tracks you are editing or tagging). 
+
+![](doc_images/audio_library_marked.png)
+
+## Batch Edit
+To begin batch editing, click the `Batch Edit` button ( <img style="vertical-align: -5px" 
+src="doc_icons/edit.svg" alt="Batch Edit" width="20" height="20"> ) in the sidebar. This will provide a checkbox 
+next to each visible source. Select the tracks you would like to batch edit and click the `Edit` button in the bottom 
+right ( <img style="vertical-align: -5px" src="doc_icons/edit.svg" alt="Edit" width="20" height="20"> ). You 
+will be presented with a pop-up and fields for entering track metadata. Values shard by your selected tracks wil be 
+automatically populated.
+
+?> **Note:** Data entered in the "Comment" field (and track tags) can be viewed by mousing over a track's Avatar.
+
+?> **Tip**: Use the _SHIFT_ key to quickly select multiple sources
+
+![](doc_images/audio_library_edit.png)
+
+## Playlists
+You can also make playlists directly within the Audio Library. To make a playlist, click the `Add to Playlist` button 
+( <img style="vertical-align: -5px" src="doc_icons/addplaylist.svg" alt="Add to Playlist" width="20" height="20"> ) in 
+the sidebar. This will provide a checkbox next to each visible source. Slect the tracks you would like to add to a 
+playlist and click the `Add to Playlist` button in the bottom right 
+( <img style="vertical-align: -5px" src="doc_icons/addplaylist.svg" alt="Add to Playlist" width="20" height="20"> ).
+Select a playlist from the list or click `+ New Playlist`. When making a new playlist, simply enter the name of your 
+playlist and select `Create Playlist`.
+
+?> **Note:** Playlists must have unique names
+
+## Delete Source Content
+Sometimes, you may want to be able to totally delete a track from your file system. To do this, **Shift+Ctrl+Alt+Click**
+the track's avatar icon. You will be prompted to confirm this choice, after which the track in FlipFlip and the file
+on your system will be deleted.
+
+?> **Note**: This can only be done for local tracks

docs/audio_tagging.md

@@ -0,0 +1,45 @@
+# Tagging
+While there is not yet a way to use tags to generate audio playlists, they are still helpful for managing your tracks
+and finding what you're looking for.
+
+The first step is to add some tags. Click the `Manage Tags` button ( <img style="vertical-align: -5px" 
+src="doc_icons/tag.svg" alt="Manage Tags" width="20" height="20"> ) in the sidebar.
+
+?> **Note**: Tags are shared between regular sources and audio tracks
+
+## Manage tags
+From this screen, we can add, remove, and re-order our tags. ("Tag phrases" do not apply to audio tracks).
+
+* To add a new tag click the `+` and then type the name of the tag and press OK
+* To edit a tag's name or "tag-phrases", click the tag.
+* To remove a tag, click the tag and then click the <img style="vertical-align: -5px" src="doc_icons/delete.svg" alt="Remove" width="20" height="20">. 
+* To manually re-order tags, simply drag'n'drop them. (This is the order which they will appear everywhere else).
+
+![](doc_images/manage_tags.png)
+
+## Tagging a track
+To tag a track in the Library, click the track's Avatar. This will start a Scene with an audio playlist, starting at 
+the selected track. To modify the tags, hover towards the bottom of the screen, and you will see your tags appear. 
+Toggle tags on/off as desired by clicking on them. When you're done, click "Back" to return to the Library.
+
+While Tagging, use `←` and `→` to skip to the previous/next visible track in the Library. 
+
+![](doc_images/audio_tagging.png)
+
+?> If "Show Audio Info" is enabled in FlipFlip Settings, track information will apear for about 8 seconds whenever a 
+track chages. 
+
+## Batch Tagging
+To begin batch tagging, click the `Batch Tag` button ( <img style="vertical-align: -5px" 
+src="doc_icons/batch.svg" alt="Batch Tag" width="20" height="20"> ) in the sidebar. This will provide a checkbox 
+next to each visible track. Select the tracks you would like to batch tag and click the `Tag` button 
+( <img style="vertical-align: -5px" src="doc_icons/tag.svg" alt="Manage Tags" width="20" height="20"> ). You 
+will be presented with a pop-up and a number of options.
+
+* Select tags and click `Overwrite` to force each selected scene to match those tags
+* Select tags and click `- Remove` to remove those tags from each selected scene.
+* Select tags and click `+ Add` to add those tags to each selected scene.
+
+?> **Tip**: Use the _SHIFT_ key to quickly select multiple sources
+
+![](doc_images/audio_library_batch.png)

docs/audio_text.md

@@ -4,19 +4,30 @@ The **AUDIO/TEXT** tab controls audio and text overlays.
 ![](doc_images/scene_detail_audio_text.png)
 
 ## Audio
-This card allows you to layer multiple audio tracks over your Scene. It also contains the audio controls for these tracks.
+This card allows you to layer multiple audio track playlists over your Scene. Each playlist, a sequence of 
+consecutive tracks, begins playing when the scene starts.
+
+In order to add tracks to your scene, you will first need to add them to your [Audio Library](library.md).
+
+Once you have tracks in your library to import, you can add a playlist by clicking the + button in the top right corner. 
+Then, click the + in the middle of the new playlist to [import tracks from your library](audio_import_from_library.md) 
+to this playlist. 
+
+Imported tracks will still have the same playback options as those in your library, but can be changed independently 
+within this scene, without effecting your library's options. You drag and drop tracks to re-order them.
+
+Click the wrench to change the following options for a track:
+* **Volume** - Control the volume of this track.
 * **Tick** - The audio file will play/restart at a certain interval.
   * Control tick timing options.
 * **Stop at End** - The Scene will stop when the audio track ends.
 * **Next Scene at End** - The Next Scene will play when the audio track ends.
 * **Speed** - Control the playback speed of this track.
 
-FlipFlip can use the BPM of the **first audio** file for timing the scene or effects. You can either (1) enter this 
+FlipFlip can use the BPM of the audios in the **first playlist** for timing the scene or effects. You can either (1) enter this 
 value manually, (2) try to detect the BPM of the entered audio file, or (3) read the BPM from the ID3 metadata of the 
 entered audio file.
 
-?> There is no limit to the number of audios you can use, but you may experience poor performance if you use too many.
-
 ## Text
 This card allows you to play a caption script over your Scene. Choose a text file that follows 
 the [caption script format](caption_script.md). This can be a local file or a remote URL.

docs/changelog.md

@@ -1,6 +1,12 @@
 # Changelog
 
-## 3.0.6 <small>(09/16/2020)</small>
+#### 3.1.0-beta1 <small>(09/25/2020)</small>
+- Easing Controls
+- Audio Library
+- Allow multiple audio playlists within Scene
+- Fix bug where scraping threads would die
+
+## 3.0.7 <small>(09/16/2020)</small>
 - New Effect: Continuous Fade In/Out (BETA)
 - New Effect: Continuous Panning (BETA)
 - Add option for Center (No Clipping)

docs/clips.md

@@ -14,15 +14,15 @@ next to the source to go to the "Video Clipper" interface:
 To create a new clip, click the `+`. To edit/view an existing clip, just click its number.
 
 A slider will appear allowing you to select the start and end of this clip. You can also enter/modify the timestamp
-directly for more precise selection. Double click "Start" or "End" to set it to the player's current timestamp. Use ↑/↓
+directly for more precise selection. Double click `Start` or `End` to set it to the player's current timestamp. Use ↑/↓
 keys to move the selected timestamp up/down 1 second.
 
 * Click <img style="vertical-align: -5px" src="doc_icons/save.svg" alt="Save" width="20" height="20"> to save changes to 
 this clip.
 * Click <img style="vertical-align: -5px" src="doc_icons/tag.svg" alt="Tag" width="20" height="20"> to start tagging this clip.
   * New clips will ineherit the source's current tags.
   * Chaging a source's tags doesn't change its clips' tags.
-  * Clip tags will be used for Scene Generators which have "Use Clips" is on, otherwise source tags will be used
+  * Clip tags will be used for Scene Generators which have `Use Clips` on, otherwise source tags will be used
     * If a clip has _no_ tags, it acts as though it has its source's tags during Scene Generation.
 * Click <img style="vertical-align: -5px" src="doc_icons/volume.svg" alt="Volume" width="20" height="20"> to set the volume
 of this clip to the current volume. Right click to reset the volume.

docs/config.md

@@ -22,16 +22,18 @@ These settings control various player options.
 * `Fullscreen` - display player in fullscreen mode
 * `Start Immediately` - don't wait for full scene to load, start as soon as first image loads
   * _Be aware this may cause the beginning to be janky, while the sources continue loading_
+* `Show Adv Easing Controls` - enables controls for advanced [easings](effects.md) in effects
+* `Show Audio Info` - when enabled, [audio information](audio_tagging#tagging-a-track) will appear during playback when a track changes.
+  * _This only ever applies to the first playlist_
 * `Portable Mode` - Portable Mode will save a copy of your data in the same directory as the FlipFlip executable, 
 as well as the default save path. This needs to be enabled on each machine.
-
-
+---
 * `Min Image/Video Size` - the minimum number of pixels each dimension of an image/video must be 
 (default: 200 - image's width _and_ height must be larger than 200px).
 * `Max in Memory` - the maximum number of images to keep in history (navigating backwards and forwards).
   * Images in memory/history are cleared when the slideshow is stopped.
 * `Max Loading at Once` - the number of threads to have loading images.
-  * _Be cautious increasing this number as this will degrade performance._
+  * _Be cautious increasing this number as this will increase processing and may degrade performance._
 
 ## Caching
 These settings control the caching abilities of FlipFlip. By default, FlipFlip caches 500MB of images in the