@@ -4,30 +4,30 @@ Mapillary Tools is a library for processing and uploading images to [Mapillary](
4
4
5
5
<!-- ts-->
6
6
7
- * [ Quickstart] ( #quickstart )
8
- * [ Requirements] ( #requirements )
9
- * [ Installation] ( #installation )
10
- * [ Video Support ] ( #video-support )
11
- * [ Usage ] ( #usage )
12
- - [ Process ] ( #process )
13
- - [ Upload Images ] ( #upload-images )
14
- - [ Upload BlackVue Videos] ( #upload-blackvue -videos )
15
- - [ Video Process ] ( #video-process )
16
- - [ Authenticate ] ( #authenticate )
17
- - [ Aliases ] ( #aliases )
18
- * [ Advanced Usage ] ( #advanced-usage )
19
- - [ Image Description] ( #image-description )
20
- - [ Zip Images] ( #zip-images )
21
- - [ Upload API] ( #upload-api )
22
- * [ Troubleshooting] ( #troubleshooting )
23
- * [ Development] ( #development )
7
+ - [ Quickstart] ( #quickstart )
8
+ - [ Requirements] ( #requirements )
9
+ - [ Installation] ( #installation )
10
+ - [ Usage ] ( #usage )
11
+ - [ Image Process ] ( #image-process )
12
+ - [ Upload Images ] ( #upload-images )
13
+ - [ Upload BlackVue Videos ] ( #upload-blackvue-videos )
14
+ - [ Upload CAMM Videos] ( #upload-camm -videos )
15
+ - [ Advanced Usage ] ( #advanced-usage )
16
+ - [ Client-side Video Process ] ( #client-side-video-process )
17
+ - [ Authenticate ] ( #authenticate )
18
+ - [ Aliases ] ( #aliases )
19
+ - [ Image Description] ( #image-description )
20
+ - [ Zip Images] ( #zip-images )
21
+ - [ Upload API] ( #upload-api )
22
+ - [ Troubleshooting] ( #troubleshooting )
23
+ - [ Development] ( #development )
24
24
25
25
<!-- te-->
26
26
27
27
## Quickstart
28
28
29
29
Download the latest ` mapillary_tools ` binaries for your platform
30
- [ here] ( https://github.com/mapillary/mapillary_tools/releases/tag/v0.9.0 ) first.
30
+ [ here] ( https://github.com/mapillary/mapillary_tools/releases/tag/v0.9.2 ) first.
31
31
See [ more installation instructions] ( #installation ) below.
32
32
33
33
Process and upload imagery:
@@ -36,6 +36,12 @@ Process and upload imagery:
36
36
mapillary_tools process_and_upload " path/to/images/"
37
37
```
38
38
39
+ Upload [ CAMM] ( https://developers.google.com/streetview/publish/camm-spec ) videos:
40
+
41
+ ``` shell
42
+ mapillary_tools upload_camm " path/to/camm_videos/"
43
+ ```
44
+
39
45
Upload BlackVue videos:
40
46
41
47
``` shell
@@ -95,28 +101,9 @@ Termux:
95
101
mv -v storage/dcim/mapillaryimages mapillaryimages
96
102
```
97
103
98
- ## Video Support
99
-
100
- To [ process videos] ( #video-process ) , you will also need to install ` ffmpeg ` .
101
-
102
- You can download ` ffmpeg ` from [ here] ( https://ffmpeg.org/download.html ) . Make sure it is executable and put the
103
- downloaded binaries in your ` $PATH ` . You can also install ` ffmpeg ` with your favourite package manager. For example:
104
-
105
- On macOS, use [ Homebrew] ( https://brew.sh/ ) :
106
-
107
- ``` shell
108
- brew install ffmpeg
109
- ```
110
-
111
- On Debian/Ubuntu:
112
-
113
- ``` shell
114
- sudo apt install ffmpeg
115
- ```
116
-
117
104
## Usage
118
105
119
- ### Process
106
+ ### Image Process
120
107
121
108
The ` process ` command geotags images in the given directory. It extracts the required and optional metadata from image
122
109
EXIF (or the other supported geotag sources), and writes all the metadata (or process errors) in
@@ -167,28 +154,80 @@ mapillary_tools upload "path/to/images/" \
167
154
168
155
### Upload BlackVue Videos
169
156
170
- BlackVue videos can be uploaded with the ` upload ` command and will be processed on Mapillary servers.
157
+ BlackVue videos can be uploaded with the ` upload_blackvue ` command directly, and they will be processed on Mapillary servers.
158
+
159
+ New in version [ v0.8.2] ( https://github.com/mapillary/mapillary_tools/releases/tag/v0.8.2 ) .
171
160
172
161
#### Examples
173
162
174
- Upload a BlackVue video with file name ` video_file_name.mp4 ` to user ` mly_user ` for organization ` mly_organization_id `
175
- . It is optional to specify ` --user_name ` if you have only one user [ authenticated] ( #authenticate ) .
163
+ Upload a BlackVue video with file name ` video_file_name.mp4 ` to user ` mly_user ` for organization ` mly_organization_id ` .
164
+ It is optional to specify ` --user_name ` if you have only one user [ authenticated] ( #authenticate ) .
176
165
177
166
``` shell
178
167
mapillary_tools upload_blackvue " video_file_name.mp4" \
179
168
--user_name " mly_user" \
180
169
--organization_key " mly_organization_id"
181
170
```
182
171
183
- Upload all BlackVue videos (* .mp4) under the folder:
172
+ Upload all BlackVue videos (\ * .mp4) under the folder:
184
173
185
174
``` shell
186
175
mapillary_tools upload_blackvue " path/to/blackvue_videos/"
187
176
```
188
177
189
- ### Video Process
178
+ ### Upload CAMM Videos
179
+
180
+ [ CAMM] ( https://developers.google.com/streetview/publish/camm-spec ) videos can be uploaded with the ` upload_camm ` command directly,
181
+ and will be processed on Mapillary servers.
182
+
183
+ New in version [ v0.9.2] ( https://github.com/mapillary/mapillary_tools/releases/tag/v0.9.2 ) .
184
+
185
+ #### Examples
186
+
187
+ Upload a CAMM video with file name ` video_file_name.mp4 ` to user ` mly_user ` for organization ` mly_organization_id ` .
188
+ It is optional to specify ` --user_name ` if you have only one user [ authenticated] ( #authenticate ) .
189
+
190
+ ``` shell
191
+ mapillary_tools upload_camm " video_file_name.mp4" \
192
+ --user_name " mly_user" \
193
+ --organization_key " mly_organization_id"
194
+ ```
195
+
196
+ Upload all CAMM videos (\* .mp4) under the folder:
197
+
198
+ ``` shell
199
+ mapillary_tools upload_camm " path/to/camm_videos/"
200
+ ```
201
+
202
+ ## Advanced Usage
203
+
204
+ ### Client-side Video Process
205
+
206
+ Client-side video processing allows users to process and upload other videos that can't be uploaded directly,
207
+ and configure sample intervals, or the other processing parameters.
208
+
209
+ #### Install FFmpeg
210
+
211
+ To [ process videos locally] ( #video-process ) , you will need to install ` ffmpeg ` .
190
212
191
- Video process involves two commands:
213
+ You can download ` ffmpeg ` from [ here] ( https://ffmpeg.org/download.html ) . Make sure it is executable and put the
214
+ downloaded binaries in your ` $PATH ` . You can also install ` ffmpeg ` with your favourite package manager. For example:
215
+
216
+ On macOS, use [ Homebrew] ( https://brew.sh/ ) :
217
+
218
+ ``` shell
219
+ brew install ffmpeg
220
+ ```
221
+
222
+ On Debian/Ubuntu:
223
+
224
+ ``` shell
225
+ sudo apt install ffmpeg
226
+ ```
227
+
228
+ #### Video Process
229
+
230
+ Client-side video process involves two commands:
192
231
193
232
1 . ` sample_video ` : sample videos into images, and insert capture times to the image EXIF. Capture time is calculated
194
233
based on the video start time and sampling interval. This is where ` ffmpeg ` is being used.
@@ -301,15 +340,13 @@ mapillary_tools sample_video "path/to/videos/" "path/to/videos/mapillary_sampled
301
340
mapillary_tools process_and_upload " path/to/videos/mapillary_sampled_video_frames/"
302
341
```
303
342
304
- ## Advanced Usage
305
-
306
343
### Image Description
307
344
308
345
As the output, the ` procss ` command generates ` mapillary_image_description.json ` under the image directory by default.
309
346
The file contains an array of objects, each of which records the metadata of one image in the image directory. The
310
347
metadata is validated
311
- by [ the image description schema] ( https://github.com/mapillary/mapillary_tools/tree/master/schema/image_description_schema.json )
312
- . Here is a minimal example:
348
+ by [ the image description schema] ( https://github.com/mapillary/mapillary_tools/tree/master/schema/image_description_schema.json ) .
349
+ Here is a minimal example:
313
350
314
351
``` json
315
352
[
@@ -387,7 +424,7 @@ Zip processed images in `path/to/images/` and write zip files in `path/to/zipped
387
424
mapillary_tools zip " path/to/images/" " path/to/zipped_images/"
388
425
```
389
426
390
- Upload all the zip files (* .zip) under the folder:
427
+ Upload all the zip files (\ * .zip) under the folder:
391
428
392
429
``` shell
393
430
mapillary_tools upload_zip " path/to/zipped_images/"
@@ -535,6 +572,7 @@ black mapillary_tools tests
535
572
```
536
573
537
574
Release a new version:
575
+
538
576
``` shell
539
577
# Assume you are releasing v0.9.1-beta
540
578
0 commit comments