Updated README, added segmenting-only job.

Author: Sjoerd Tieleman

README.markdown

@@ -165,23 +165,17 @@ The `thumbnail_options` object is optional and contains a set of thumbnails that
 
 If you specify thumbnails but an error occurs during generation, your job will be marked as failed. If you don't specify a valid `seconds` or `percentages` option thumbnail generation will be skipped but the job can still be completed successfully.
 
-The `segments_options` object is optional and contains segment time (duration) in seconds.
-Segmented videos are used in [HLS](https://en.wikipedia.org/wiki/HTTP_Live_Streaming).
-These options applied to encoded video, thus `encoder_options` are required.
-Moreover `encoder_options` should prepare video for segmenting, because bitstream
-filter [h264_mp4toannexb](https://www.ffmpeg.org/ffmpeg-bitstream-filters.html#h264_005fmp4toannexb) will be applied to the video.
+The `segments_options` object is optional and contains segment time (duration) in seconds. Segmented videos are used in [HLS](https://en.wikipedia.org/wiki/HTTP_Live_Streaming). These options are applied to the encoded video, thus `encoder_options` are required. Moreover `encoder_options` should prepare video for segmenting, because bitstream
+filter [h264_mp4toannexb](https://www.ffmpeg.org/ffmpeg-bitstream-filters.html#h264_005fmp4toannexb) will be applied to the video. Therefore it is recommended to transcode to an MP4 file before segmenting.
 
 The segmenting command looks like:
-```
-ffmpeg -i /tmp/46ee0a404a4b75d85c09d98a7c6b403579ee9f99.mp4 -codec copy -map 0 \
--f segment -vbsf h264_mp4toannexb -flags -global_header -segment_format mpegts \
--segment_list /path/to/dest_file_dir/dest_file_name.m3u8 -segment_time 10 \
-/path/to/dest_file_dir/dest_file_name-%06d.ts
-```
-
-"46ee0a404a4b75d85c09d98a7c6b403579ee9f99.mp4" is a temporary encoded file which is not moved to destination folder yet. 
 
+    ffmpeg -i /tmp/46ee0a404a4b75d85c09d98a7c6b403579ee9f99.mp4 -codec copy -map 0 \
+      -f segment -vbsf h264_mp4toannexb -flags -global_header -segment_format mpegts \
+      -segment_list /path/to/dest_file_dir/dest_file_name.m3u8 -segment_time 10 \
+      /path/to/dest_file_dir/dest_file_name-%06d.ts
 
+`46ee0a404a4b75d85c09d98a7c6b403579ee9f99.mp4` is a temporary encoded file (generated by Codem). After transcoding and segmenting you end up with the transcoded file, as well as the segments/playlist.
 
 ### Thumbnail-only job
 
@@ -284,15 +278,14 @@ Thumbnail-only job (160x90 in PNG format every 10% of the video).
 
 Segmenting job.
 
-    # curl -d '{"source_file": "/tmp/video.mp4", "destination_file": "/tmp/output/test.mp4", "encoder_options": "-vb 2000k -minrate 2000k -maxrate 2000k -bufsize 2000k -vf scale=min'(iw,1280)':-1 -s 1280x720 -acodec libfdk_aac -ab 192000 -ar 44100 -ac 2 -vcodec libx264 -movflags faststart -sn -r 29.97 -threads 0", "segments_options": {"segment_time": 10} }' http://localhost:8080/jobs
+    # curl -d '{"source_file": "/tmp/video.mp4", "destination_file": "/tmp/output/test.mp4", "encoder_options": "-vb 2000k -minrate 2000k -maxrate 2000k -bufsize 2000k -s 1280x720 -acodec aac -strict -2 -ab 192000 -ar 44100 -ac 2 -vcodec libx264 -movflags faststart", "segments_options": {"segment_time": 10} }' http://localhost:8080/jobs
 
     Output: {"message":"The transcoder accepted your job.","job_id":"7dc3c268783d7f3c737f3a134ccf1d4f15bb8442"}
 
     Status of finished job:
 
     # curl http://localhost:8080/jobs/7dc3c268783d7f3c737f3a134ccf1d4f15bb8442
 
-    ```javascript
     Output:
     {
       "id": "7dc3c268783d7f3c737f3a134ccf1d4f15bb8442",
@@ -311,8 +304,32 @@ Segmenting job.
         "/tmp/output/test-000005.ts"
       ]
     }
-    ```
 
+Segmenting-only job (you are expected to have a valid MP4 file suitable for segmenting as the input).
+
+    # curl -d '{"source_file": "/tmp/video.mp4","destination_file":"/tmp/segments/video.mp4","encoder_options": "", "segments_options": {"segment_time": 10} }' http://localhost:8080/jobs
+
+    Output: {"message":"The transcoder accepted your job.","job_id":"c7599790527c0bb173cc7a0c44411aaca5c1550a"}
+
+    Status of finished job:
+    
+    # curl http://localhost:8080/jobs/c7599790527c0bb173cc7a0c44411aaca5c1550a
+    
+    Output:
+    {
+      "id":"c7599790527c0bb173cc7a0c44411aaca5c1550a",
+      "status":"success",
+      "progress":1,
+      "duration":26,
+      "filesize":6734045,
+      "message":"finished segmenting job.",
+      "playlist":"/tmp/segments/video.m3u8",
+      "segments":[
+        "/tmp/segments/video-000000.ts",
+        "/tmp/segments/video-000001.ts",
+        "/tmp/segments/video-000002.ts"
+      ]
+    }
 ## Issues and support
 
 If you run into any issues while using codem-transcode please use the Github issue tracker to see if it is a known problem

lib/job.js

@@ -309,8 +309,9 @@ var Job = JobUtils.getDatabase().define('Job', {
       var playlistDir      = path.dirname(destinationFile);
       var playlistPath     = [playlistDir, playlistName].join(path.sep) + '.m3u8';
       var segmentsFormat   = [playlistDir, playlistName].join(path.sep) + '-%06d.ts'
-
-      args.push('-i', job.tmpFile,
+      var inputFile        = (this.parsedOpts()['encoder_options'].length > 0) ? job.tmpFile : this.parsedOpts()['source_file']
+      
+      args.push('-i', inputFile,
                 '-codec', 'copy', '-map', '0', '-f', 'segment',
                 '-vbsf', 'h264_mp4toannexb', '-flags', '-global_header',
                 '-segment_format', 'mpegts', '-segment_list', playlistPath,
@@ -410,8 +411,12 @@ var Job = JobUtils.getDatabase().define('Job', {
       }
 
       if (!job.tmpFile) {
-        // No tmpFile, hence no transcoding, only thumbnails
-        job.exitHandler(code, 'finished thumbnail job.');
+        // No tmpFile, hence no transcoding, only thumbnails or segmenting
+        if (job.parsedOpts()['thumbnail_options']) {
+          job.exitHandler(code, 'finished thumbnail job.');
+        } else {
+          job.exitHandler(code, 'finished segmenting job.');
+        }
         return;
       }